Skip to main content

​
Pagination

When endpoints return large lists of records, pagination helps manage the response. Use the page and take query parameters to control pagination:
  • page: Specifies the page number to retrieve. Default is 1.
  • take: Specifies the number of records per page. Default and maximum are 100. Some endpoints cap it lower.
  • next: A cursor token, used only by the endpoints that return one.
Counts come back in response headers: pagination-count, pagination-page and pagination-take, plus pagination-next on cursor endpoints. To retrieve the first 50 assistants in an organization, use the following query parameters:

​
Filtering

Endpoints may support filtering to refine responses. Filtering parameters vary by endpoint. For example, the /assistants endpoint supports the following filters:
  • search: Search for a specific term within the response.
To search for assistants with the term “Issue” use the query parameters:
Filtering parameters vary by endpoint. Refer to the endpoint documentation for the specific parameters supported.