Skip to main content
GET
/
api
/
v1
/
invitations
List Invitations
curl --request GET \
  --url https://api.example.com/api/v1/invitations
{
  "invitations": [
    {
      "id": "<string>",
      "account_id": "<string>",
      "account_code": "<string>",
      "email": "<string>",
      "invited_by": "<string>",
      "expires_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "status": "pending",
      "token": "<string>",
      "accepted_at": "2023-11-07T05:31:56Z",
      "email_sent": false,
      "email_sent_at": "2023-11-07T05:31:56Z"
    }
  ],
  "total": 123
}

Headers

authorization
string | null

Query Parameters

status_filter
enum<string> | null

Invitation status enum.

Available options:
pending,
accepted,
expired,
cancelled
account_id
string | null

Response

Successful Response

Response schema for listing invitations.

invitations
InvitationResponse · object[]
required

List of invitations

total
integer
required

Total number of invitations