Pagination and Filtering

limit, offset, and list query parameters

Most list endpoints support pagination and return metadata alongside the collection.

Pagination query parameters

ParameterDefaultMaximumDescription
limit10100Maximum items to return
offset0Number 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:

ParameterDescription
sortcreated (default), companyName, or usersCount
datefromISO date — customers created on or after this date
datetoISO date — customers created on or before this date
searchTermFilter by search term
ascendingtrue / false — sort direction
includeDeletedInclude 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=100

Other filtered lists

EndpointNotable filters
GET /customers/{customerID}/activitiesdatefrom, dateto, type, direction
GET /jobslimit, offset only
GET /webhookslimit, offset

Refer to API Reference for the full parameter list per endpoint.


Did this page help you?