Pagination
List endpoints use cursor-based pagination. Each response contains a page of up to 100 results indata and a link to the next page in links.next:
links.next as it is. It keeps your sorting and filters. When links.next is null, you have reached the last page.
Sorting
Use thesort query parameter to sort results by a field. Results are sorted in ascending order. Prefix the field with - to sort in descending order:
sort, the endpoint’s default sort order applies. An unsupported sort field returns 400 Bad Request.
Results with the same value in the sort field always appear in the same order, so pagination doesn’t skip or repeat results.
Filtering
Filters use query parameters in the formfilter[name]=value:
- If you combine filters, results must match all of them.
- An unsupported filter or an invalid value returns
400 Bad Request. - Filters ending in
_since, such asfilter[created_since], match results at or after the given timestamp. Timestamps must use the formatYYYY-MM-DDTHH:MM:SSZin UTC.
With
curl, add -g (--globoff) to URLs with filters. Otherwise, curl interprets the brackets as a URL pattern and doesn’t send the request. Other HTTP clients send brackets as they are or encode them automatically. The API accepts both.