HomeGuidesRecipesAPI ReferenceChangelog
GuidesAPI ReferenceCustomer Help CenterLog In
These docs are for v2017-01-01. Click to read the latest docs for v2021-03-10.

Pagination

By default, most API endpoints return a maximum of 20 records per page. You can change the number of records by passing a limit parameter in the request URL parameters. However, the maximum you records returned by the API at one time will never be more than 100.

Every paginated response is in the following format:

{
  "data": [
    // Array of objects
  ],
  "paging": {
    "next": "/api/purchases?seller=584f61efcb2256a6132c6e04&limit=50&skip=50",
    "total": 500,
  }
}

The data attribute contains all the objects being requested. The paging objects contains two attributes: next and total. You can get further data by following the next attribute, stopping when it is is null.