Sign in

v1

latestOpenAPI 3.1.02026-08-065163115.0 KB
Invites

List invites

Returns a paginated list of invites for the given business. Includes both pending and accepted invites; excludes cancelled invites.

get/v1/businesses/{client_id}/invites

Path parameters

client_idinteger required
Example:123

The ID of the business.

Query parameters

offsetinteger
Example:50

Offset to retrieve items from.

limitinteger
Example:50

Number of items per page.

Response

OK

countinteger

The total number of invites that match the query.

nextstring nullable

The URL to the next page of invites.

previousstring nullable

The URL to the previous page of invites.

Example response

{
  "count": 10,
  "next": "offset=50&limit=50",
  "results": [
    {
      "id": 99,
      "email": "jane.doe@example.com",
      "role_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "role": "Team Member",
      "payment_types": [
        "cards",
        "reimbursements"
      ],
      "created": "2026-05-01T00:00:00Z",
      "updated": "2026-05-01T00:00:00Z"
    }
  ]
}