Admiral

Invitations

List invitations

GET
/v1/invitations

Scope: user:read

Authorization

bearerAuth
AuthorizationBearer <token>

An API key, or an access token minted from one. Pass it in the Authorization header: Bearer admp_...

In: header

Query Parameters

filter?filter

Filter expression to narrow results. Uses the Admiral filter DSL (see the API documentation for the full operator and predicate reference).

Filterable fields:

  • email: filter by address.
  • status: filter by lifecycle status.

Example: field['status'] = 'STATUS_PENDING'

Lengthlength <= 1024
page_size?page_size

Maximum number of invitations to return per page. Defaults to 50 when omitted or 0; must not exceed 100.

Formatint32
Range0 <= value <= 100
page_token?page_token

Opaque pagination token from a previous response.

Response Body

application/json

curl -X GET "https://example.com/v1/invitations"
{  "invitations": [    {      "id": "string",      "email": "user@example.com",      "role": "USER_ROLE_ADMIN",      "status": "STATUS_UNSPECIFIED",      "invited_by": {        "id": "string",        "display_name": "string",        "email": "string"      },      "created_at": "2023-01-15T01:30:15.01Z",      "expires_at": "2023-01-15T01:30:15.01Z",      "accepted_at": "2023-01-15T01:30:15.01Z",      "accepted_by": {        "id": "string",        "display_name": "string",        "email": "string"      },      "revoked_at": "2023-01-15T01:30:15.01Z"    }  ],  "next_page_token": "string"}

Invite someone into the current tenant POST

A live invitation for the same address is retired and replaced, so a retry or a "send it again" is this same call. ALREADY_EXISTS when the address is already a member. INVALID_ARGUMENT for OWNER, which moves by transfer, never by invitation. Scope: `user:write`

Withdraw an invitation POST

Scope: `user:write`