Introduction To Searching & Pagination

Many GET endpoints support query parameters for filtering, sorting, and pagination. These include endpoints like Message History, Contact Lists, Opt-Outs, and Campaigns.

Parameter
Type
Description

sortField

string

The field to sort results by (e.g., created_on).

sortDir

string

Direction of sorting: ASC (ascending) or DESC (descending).

offset

number

Number of records to skip (for pagination).

limit

number

Maximum number of records to return per page (e.g., 10).

We recommend that you use these prameters to effectively handle larger datasets.

circle-info

All endpoints that return lists may support these parameters. Check individual endpoint docs for availability.

Last updated