All top-level API endpoints have support for bulk fetches via "list" API methods.
Some endpoints will return data in a paginated list. A paginated response will look similar to this:
As per the example above, each paginated response will have the
dataarray, which contains all the items from the specific page, a
linksobject with full URLs for fetching
nextpages, and the
metaobject which contains all the info about the resource you are paginating.
Some endpoints allow you to specific number of records that you want to receive per page. To achieve that you can append the
per_page=Xparameter to the URL of the request. For example, if you want to request
50users per page, the URL parameters should look like the following:
Pagination limit is set to
100for most resources which means that you cannot request more than
100records per page. If you provide a larger number, it will be ignored and
100records per page will be returned.
To request a different page, just append the
page=Xparameter to the URL. For our customers example above, you can get the second page like following: