Pagination

The Catenda APIs use pagination to limit the number of items returned in a response. Set the number of items in a page and which page to return using the following parameters.

Parameter

Description

page

The page number to return, default value is 1.

pageSize

The number of items to return in a response, default value is 100.

The response will include two headers to assist with further pagination operations.

Link header

The Link header includes URLs for the first, last, next, and previous pages of the resource. This header is useful for navigating through the pages of a resource and knowing when you have reached the end of the list.

The following is an example value of the Link header for the second page of a resource with 10 items per page.

URL


X-Total-Count header

The X-Total-Count header includes the total number of items available in the resource.

Updated 11 Jun 2024
Did this page help you?