v13

latestOpenAPI 3.0.3MITraw.githubusercontent.com2026-08-04237161688.6 KB

Invitations

List all invitations

Returns all non-revoked invitations for your application, sorted by creation date

get/invitations

Query parameters

status'pending' | 'accepted' | 'revoked' | 'expired'

Filter invitations based on their status

querystring

Filter invitations based on their email_address or id

order_bystring

Allows to return invitations in a particular order. At the moment, you can order the returned invitations either by their created_at, email_address or expires_at. In order to specify the direction, you can use the +/- symbols prepended in the property to order by. For example, if you want invitations to be returned in descending order according to their created_at property, you can use -created_at. If you don't use + or -, then + is implied. Defaults to -created_at.

paginatedboolean

Whether to paginate the results. If true, the results will be paginated. If false, the results will not be paginated.

limitinteger

Applies a limit to the number of results returned. Can be used for paginating the results together with offset.

offsetinteger

Skip the first offset results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with limit.

Response

List of invitations

object'invitation' required

idstring required

email_addressstring email required

public_metadataobject required

revokedboolean

status'pending' | 'accepted' | 'revoked' | 'expired' required

urlstring

expires_atinteger nullable

Unix timestamp of expiration.

created_atinteger required

Unix timestamp of creation.

updated_atinteger required

Unix timestamp of last update.

Example response

[
  {
    "status": "pending"
  }
]