Pagination and Filtering
limit, offset, and list query parameters
Most list endpoints support pagination and return metadata alongside the collection.
Pagination query parameters
| Parameter | Default | Maximum | Description |
|---|---|---|---|
limit | 10 | 100 | Maximum items to return |
offset | 0 | — | Number of items to skip |
Example
GET /v2/customers?limit=25&offset=50
Authorization: Bearer <token>Response shape
List responses include:
{
"customers": [ ... ],
"total": 120,
"limit": 25,
"offset": 50
}Field names match the resource (jobs, webhooks, numbers, etc.).
Customer list filters
GET /customers supports additional query parameters:
| Parameter | Description |
|---|---|
sort | created (default), companyName, or usersCount |
datefrom | ISO date — customers created on or after this date |
dateto | ISO date — customers created on or before this date |
searchTerm | Filter by search term |
ascending | true / false — sort direction |
includeDeleted | Include deleted customers when true |
Default date window
Important: If you omit
datefrom, the API defaults to customers created in the last 7 days only.
To list older customers, pass an explicit datefrom, for example:
GET /v2/customers?datefrom=2020-01-01&limit=100Other filtered lists
| Endpoint | Notable filters |
|---|---|
GET /customers/{customerID}/activities | datefrom, dateto, type, direction |
GET /jobs | limit, offset only |
GET /webhooks | limit, offset |
Refer to API Reference for the full parameter list per endpoint.
Updated 3 months ago
Did this page help you?
