/
Pagination

Pagination

Any resource which returns a collection of items will be subject to pagination. The default page size used in Public Site API is 50 items per page. Although no page size limit is enforced; it is not generally recommend exceeding a page size of 250. In order to keep the documentation concise, none of the API specifications will include information about pagination. Shown below in Figure 1 and Figure 2, is a default template depicting the format of how the pagination of data works within the Public API. For information concerning pagination parameters, please refer to Table 4.

Table 4. Pagination parameters

Key

Description

Page

Specifies the page. When missing, page 1 is presumed.

PageSize

Specifies the page size. When missing, the default size is presumed.




A sample JSON paginated return
{
    "Data": [
      "Item1..",
      "Item2.."
    ],
    "Paging": {
        "Previous": "/api/v1/someResource/?page=1",
        "Next": "/api/v1/someResource/?page=3"
    }
}
A sample JSON paginated return with a custom page size.
{
    "Data": [
      "Item1..",
      "Item2.."
    ],
    "Paging": {
        "Prevoius": "/api/v1/someResource/?page=1&pageSize=100",
        "Next": "/api/v1/someResource/?page=3&pageSize=100"
    }
}

Related content

Rate Limiting
Rate Limiting
More like this
Code Samples
Code Samples
Read with this
Rate Limiting
Rate Limiting
More like this
Animals
Read with this
HTTP Status Codes
HTTP Status Codes
More like this
Common to all API resources.
Common to all API resources.
Read with this