Skip to content
Home/
REST API Reference
/
/
Cursor based pages

Cursor based pages

Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data. A "cursor" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or "pages" as needed.

typestring

the type of object pages.

Value:"pages"
Example:"pages"
pageinteger

The current page

Example:1
nextobject or null(Pagination: Starting After)
per_pageinteger

Number of results per page

Example:2
total_pagesinteger

Total number of pages

Example:13
{
  "type": "pages",
  "page": 1,
  "next": {
    "per_page": 2,
    "starting_after": "your-cursor-from-response"
  },
  "per_page": 2,
  "total_pages": 13
}