Paginated API responses
List endpoints utilize a standardized format that contains the requested list in adata
response object, as well as some metadata that’s useful for pagination in the pagination_metadata
response object.
Generically, the response format is:
has_more
will betrue
if there are more results that were not returned by this endpoint due to thelimit
value set.next_cursor
is a string value that will be non-null
ifhas_more
istrue
. This value should be provided to the same endpoint in a subsequent call to fetch more results, maintaining the same sort order.
has_more=True
, pass the next_cursor
response as the cursor
query parameter to fetch the next page of results.
By default, paginated resources are sorted from most recently created to least recently created, determined by the created_at
field on each resource.
Limits
Orb implements a default page size of 20, with a maximum upper bound of 100 items per request. The number of items requested can be specified by passing in thelimit
query parameter to a paginated request.