Skip to main content

Pagination, filtering, and sorting

List endpoints document their supported query parameters in the API reference. Do not send filters or sort parameters that the endpoint does not list.

Cursor pagination​

Canonical list endpoints use cursor pagination:

  • limit: maximum objects to return, default 25, maximum 100
  • starting_after: return objects after this cursor
  • ending_before: return objects before this cursor

Do not send starting_after and ending_before together.

List responses use:

{
  "object": "list",
  "data": [],
  "has_more": false,
  "next_cursor": null,
  "url": "/api/v1/example"
}

Continue paging while has_more is true.

Endpoint-specific lists​

Some product or integration endpoints use endpoint-specific list shapes, such as date windows, status filters, provider filters, or upstream cursors. Use the generated endpoint page as the contract for parameter names, defaults, and bounds.

Sorting​

Sorting is endpoint-specific. Use only documented sort, sort_by, or sort_dir values for the endpoint you are calling. If no sort parameter is documented, preserve the returned order.