Ziplink’s API is using pagination for returning sets of resources in most cases. Using the pagination parameters, you can control the number of resources returned per page and the starting point of the page.

​
Pagination Parameters

​
limit
string
default:"10"

The limit parameter controls the number of resources returned per page. It accepts a positive integer value. The maximum value is 100.

​
offset
string
default:"0"

The offset parameter controls the starting point of the page. It accepts a non-negative integer value.

​
Paginated Response

An example of a paginated response is similar to the following:

Example paginated response
{
  "pagination": {
    "page_number": 5,
    "page_size": 10,
    "total": 1000
  },
  "items": [
    ...
  ]
}