Pagination Parameters
Include these in your search request body:| Parameter | Type | Default | Min | Max | Description |
|---|---|---|---|---|---|
page | integer | 1 | 1 | — | The page number to retrieve |
per_page | integer | 25 | 1 | 250 | Number of results per page |
Pagination Response
Every search response includes apagination object alongside the data array:
| Field | Type | Description |
|---|---|---|
page | integer | Current page number |
per_page | integer | Results per page (as requested) |
total_results | integer | Total number of matching records |
total_pages | integer | Total number of pages |
has_next_page | boolean | true if there are more pages after this one |
has_previous_page | boolean | true if there are pages before this one |
Sorting
Sort results by one or more fields using thesort array:
| Key | Type | Required | Description |
|---|---|---|---|
field_id | string | Yes | The field to sort by |
direction | string | Yes | "asc" (ascending) or "desc" (descending) |
Multi-column sorting
Pass multiple sort objects to sort by multiple fields. They are applied in order — the first entry is the primary sort, the second breaks ties, and so on.Default sort
If you omit thesort parameter, the server applies a default sort order. The default varies by endpoint but generally returns the most relevant results first.
Sortable fields
Not all fields support sorting. Use the List Fields endpoint to check which fields are available, then refer to the endpoint documentation for sorting constraints. Attempting to sort by a non-sortable field returns avalidation_error.
Iterating Through All Pages
To retrieve all results, loop through pages untilhas_next_page is false.
Performance Tips
Use smaller pages for faster responses
Smaller
per_page values return faster. Use per_page: 25 for interactive UIs and per_page: 250 for batch processing.Only fetch what you need
Use the
fields parameter to request only the fields you need. Fewer fields means smaller payloads and faster responses.Avoid deep pagination
Requesting very high page numbers (e.g., page 500) is slower than early pages. If you need to process large result sets, consider narrowing your filters instead.
Sort deliberately
Sorting by indexed fields is faster. If performance matters, avoid multi-column sorts on non-indexed fields.