Pagination

Zoho Backstage provides APIs to retrieve lists of various resources, such as contacts and plans. These lists are paginated, with a default limit of 200 items per page. Pagination details are included in the API response under the page_context node.

By default, the first page of results will be returned. To navigate through subsequent pages, use the page parameter in your request. You can also customize the number of records returned per page by adjusting the per_page parameter.

Pagination Fields Explained

total_count: The total number of records available across all pages.

page: The current page number being displayed in the response.

per_page: The number of records displayed per page, as specified in the request.

total_pages: The total number of pages available based on per_page and

has_more_items: A Boolean value indicating whether there are additional pages of data available beyond the current page.

Sample Response

Copied{
  "pagination": {
    "total_count": 5,
    "page": 1,
    "per_page": 100,
    "total_pages": 1,
    "has_more_items": false
  },
  "data": [
    { . . . }
  ]
}