List Invitations
GET /invitations
GET /invitationsInteractive request editor loads with JavaScript.
Authorization
BearerAdminToken Organization-scoped admin token. Read operations require a valid token, and write operations require a token with write permission.
In: header
Query Parameters
Set to true to include invitations that are already
accepted, revoked or expired.
Response Body
application/json
application/json
application/json
curl -X GET "$AISIX_CP/invitations" \ -H "Authorization: Bearer $AISIX_TOKEN"OK
{
"data": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b",
"email": "string",
"role": "string",
"status": "pending",
"expires_at": "2019-08-24T14:15:22Z",
"created_at": "2019-08-24T14:15:22Z",
"inviter": {
"user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
"email": "string",
"display_name": "string"
}
}
]
}Request body or parameters failed validation.
{
"error": {
"code": "string",
"message": "string"
}
}Missing or invalid bearer.
{
"error": {
"code": "UNAUTHENTICATED",
"message": "no org context"
}
}Complete operation details and schema variants
GET /invitations
List Invitations
List the organization's invitations. By default only invitations
that can still be redeemed are returned; pass
include_stale=true to also see accepted, revoked and expired
ones.
Parameters
include_stale(query, boolean, optional): Set totrueto include invitations that are already accepted, revoked or expired.
Responses
-
200: OK -
data(array, required): -
data[].id(string, required): -
data[].org_id(string, required): -
data[].email(string, required): Address the invitation was issued to, lowercased. Redemption is bound to it — no other address can claim the link. -
data[].role(string, required): Organization role the invitee receives on redemption. A built-in role (owner,admin,member) or a custom role name. -
data[].status(string, required):pendingis the only redeemable state.expiredis derived fromexpires_atat read time, not stored. -
data[].expires_at(string, required): When the link stops working.nullfor an invitation with no expiry. -
data[].created_at(string, required): -
data[].inviter(object, required): -
data[].inviter.user_id(string, required): -
data[].inviter.email(string, required): -
data[].inviter.display_name(string, required): -
400: Request body or parameters failed validation. -
error(object, required): Error details. -
error.code(string, required): Machine-readable identifier. Examples:UNAUTHENTICATED,INVALID_REQUEST,MASTER_KEY_UNSET,INTERNAL. -
error.message(string, required): Human-readable explanation; safe to surface to operators. -
401: Missing or invalid bearer. Response fields (application/json): identical toGET /invitations, response 400 above.
cURL
curl -X GET '$AISIX_CP/invitations' -H 'Authorization: Bearer $AISIX_TOKEN'