Organization API › Invitations
List invitations
GET/api/v1/invitations
Every invitation the organization has sent, with its status. The invitation token is left out ("").
Permission (API-key scope): identity:user:invite.
Authorization
bearerAuth(identity:user:invite)apiKeyHeader(identity:user:invite)
Responses
200
The invitations.
dataarray of Invitation requiredShow Invitation properties
idstring requiredorg_idstring requiredemailstring (email) requiredrolestring requiredrole_idsarray of string | nullRoles held on arrival.team_idsarray of string | nullTeams joined on arrival.tokenstringThe secret the invitation email carries. Always empty ("") in a response to the organization; only the email carries it.statusstring requiredinvited_bystring requiredexpires_atstring (date-time) requiredSeven days after it was sent (or last resent).accepted_atstring (date-time)created_atstring (date-time) required
successboolean required
401
No API key was sent, or it is unknown, revoked or expired (UNAUTHORIZED).
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThe response'sX-Request-ID; quote it to support.
403
The key lacks the scope this endpoint needs (FORBIDDEN).
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThe response'sX-Request-ID; quote it to support.
429
Too many requests (RATE_LIMITED). Wait Retry-After seconds.
Retry-AfterintegerSeconds to wait.
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThe response'sX-Request-ID; quote it to support.
500
Something went wrong on EvoHub's side (INTERNAL_ERROR). Retry later.
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThe response'sX-Request-ID; quote it to support.
Example request
curl -X GET 'https://evohub.io/api/v1/invitations' \
-H 'Authorization: Bearer <TOKEN>'