Skip to content
Home/
REST API Reference
/
/
Paginated Response

Paginated Response

A paginated list of notes associated with a contact or a company. On the last page, pages.next is null. These lists never send pages.prev.

typestring

String representing the object's type. Always has the value list.

Example:"list"
dataArray of objects(Note)

An array of notes.

total_countinteger

A count of the total number of notes.

Example:1
pagesobject(Pagination Object)

The majority of list resources in the API are paginated to allow clients to traverse data over multiple requests.

Their responses are likely to contain a pages object that hosts pagination links which a client can use to paginate through the data without having to construct a query. The link relations for the pages field are as follows.

{
  "type": "list",
  "data": [
    { … }
  ],
  "total_count": 1,
  "pages": {
    "type": "pages",
    "page": 1,
    "next": "http://example.com",
    "prev": "http://example.com",
    "per_page": 50,
    "total_pages": 1
  }
}