Pagination

Our APIs use cursor-based pagination to return collections of resources in manageable chunks. Pagination helps protect our services from accidental misuse, improves performance, and ensures predictable behavior for clients.

Default and maximum page size

• Default page size: 50 items
• Maximum page size: 100 items

These are the standard defaults across our APIs. However, individual resources may define different defaults or limits depending on their use case and performance characteristics. Please refer to each resource’s documentation for specific details.

If a request does not specify a page size, the default will be applied. Requests that exceed the maximum size will be capped.

Response format

Paginated responses return both the resource data and a pagination object.

{
  "data": [
    {
      "id": "1",
      "name": "John Doe"
    },
    {
      "id": "2",
      "name": "Richard Roe"
    }
  ],
  "pagination": {
    "nextPageToken": "dG9rZW4xMjM",
    "previousPageToken": "cHJldmlvdXNUb2tlbg"
  }
}

Example request with page token

When making requests to resoures, API Consumers should pass pageToken as query parameter:

GET /organization/v3/groups?pageToken=dG9rZW4xMjM

Best practices

• API Consumers must treat the cursor as an opaque string — do not inspect or construct it manually.