Get invitations sent
When you send invitations, the API creates a member account, which the person can activate by accepting the invitation. This endpoint fetches an array of the member accounts created by the invitations you sent, including whether or not the person has accepted them yet.
Request
HTTP Header | Value |
---|---|
Authorization |
A valid JSON Web Token, of the form Bearer ENCODEDHEADER.ENCODEDPAYLOAD.ENCODEDSIGNATURE
|
Examples
Response
If you’ve provided a valid JSON Web Token, the API returns an array of the member objects for members that you have invited. This could return an empty array if you’ve never invited anyone.
If the API could not verify your authentication, it responds with a 401
HTTP status.
Property | Value Type | Value |
---|---|---|
id |
number |
The unique numerical ID for this account. |
name |
string |
Optional. The name this member has given for henself. This property only appears if the member has provided a name. |
email |
string |
The email address associated with this account. |
bio |
string |
Optional. A biographical snippet written by the member, in unparsed Fifth World Markdown. |
links |
object |
An object of links that the member has added to hens account. Properties include
facebook , twitter , github , patreon , and
web . |
active |
boolean |
If true , this member has an active status on the website. If set to
false , either the member has not yet accepted her invitation, or an
administrator deactivated her account. |
nopass |
boolean |
If true , this member has not yet set a passphrase on hens account. This happens when
hen has not accepted the invitation yet, so when nopass equals true , then
accepted equals false , and vice versa. |
admin |
boolean |
If true , then this member has administrative privileges. |
accepted |
boolean |
If true , then this person has accepted hens invitation and become a member. If
false , then this person has not yet accepted hens invitation, and it remains only
a potential member account. |