Skip to main content
List endpoints return a page of results at a time. Each response has an items array and a pagination object that tells you whether more results exist and how to fetch them.

Response shape

Every list endpoint returns the same shape.
string | null
Pass as cursor on your next request to fetch the following page. null on the last page.
string | null
Pass as cursor to fetch the previous page. null on the first page.
boolean
true when more results exist beyond this page.
integer
The page size actually applied, after clamping to the maximum.
integer
The record offset this page starts from.
integer
The number of items in this page. May be less than limit on the last page.
integer
The total number of records matching the query.

Request parameters

limit is clamped, not rejected. A limit above 100 returns 100 results rather than an error.

Walking through pages

Start with no cursor, then pass next_cursor on each request until has_more is false.

Cursors

Cursors are opaque tokens returned by the API. Do not build them or read meaning from their value. Always use the next_cursor and prev_cursor from a response. Passing a malformed cursor returns a 400 with error_code BAD_REQUEST.

Tips

  • Check has_more to decide whether to continue, rather than comparing returned to limit.
  • Store next_cursor between requests instead of computing offsets yourself.