logo
UsersList invites

List invites

Returns a paginated list of user invites, with optional filters for status and role.

Use nextPageStartKey to paginate.

curl -X GET "https://api-sandbox.contasimples.com/users/v1/invites?status=PENDING&roleId=uuid-role-id&limit=10&nextPageStartKey=example_string" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "data": [
    {
      "id": "uuid-invite-id",
      "email": "user@company.com",
      "role": {
        "id": "uuid-role-id"
      },
      "expiresAt": "2025-12-31T23:59:59.000Z"
    }
  ],
  "nextPageStartKey": "example_string",
  "limit": 10
}
GET
/users/v1/invites
GET
Bearer Token
Bearer Tokenstring
Required

Bearer token from OAuth 2.0 client credentials. Format: Bearer {token}

Bearer token from OAuth 2.0 client credentials. Format: Bearer {token}
query
statusstring

Filter by invite status.

Options: PENDING, EXCLUDED, EXPIRED
query
roleIdstring

Filter by the invite’s role ID.

Format: uuid
query
limitinteger

Maximum invites per page. Min: 1, max: 100. Default: 10.

Min: 1 • Max: 100
query
nextPageStartKeystring

Opaque pagination token from the previous response. Pass it back unchanged to fetch the next page.

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Bearer token from OAuth 2.0 client credentials. Format: Bearer {token}

Query Parameters

statusstring

Filter by invite status.

Allowed values:PENDINGEXCLUDEDEXPIRED
roleIdstring

Filter by the invite’s role ID.

limitinteger

Maximum invites per page. Min: 1, max: 100. Default: 10.

nextPageStartKeystring

Opaque pagination token from the previous response. Pass it back unchanged to fetch the next page.

Responses

dataarray
Required

List of invites.

nextPageStartKeystring

Next page token. If absent, no more pages. Pass in nextPageStartKey.

limitinteger

Items per page.