v1

latestOpenAPI 3.0.02026-07-2482421001.1 KB
User management

List invitations

This API returns a paginated list of pending invitations for your organization. Use this endpoint to review outstanding invitations before sending reminders or re-inviting users whose invitations have expired.

get/v1/invitations

Query parameters

offsetinteger

Number of records to skip from the beginning of the result set. Use this with limit for pagination.

limitinteger
Example:50

Maximum number of records to return per page, starting from the specified offset value.

Response

Invitations retrieved successfully

totalinteger

Total number of pending invitations in your organization.

offsetinteger

The number of records skipped for this page. Reflects the offset value submitted in the request.

limitinteger

The maximum number of records returned for this page. Reflects the limit value submitted in the request.

Example response

{
  "invitations": [
    {
      "email": "jane.doe@example.com",
      "first_name": "Jane",
      "last_name": "Doe",
      "invited_by_account_pk": 1042,
      "created_at": "2026-06-08T10:30:00Z",
      "expires_at": "2026-06-15T10:30:00Z"
    }
  ],
  "total": 2,
  "limit": 50
}
All 82 operations