GET/calls

List calls

Lists calls in a paginated result set. Use page and per_page to navigate the results; per_page defaults to 25 and has a maximum of 25.

3 parameters
pageintegeroptional
The page of results to retrieve. Defaults to the first page when omitted.
per_pageintegeroptional
The number of results per page. Defaults to 25 when omitted and has a maximum of 25.
Intercom-Versionstringoptional
The Intercom API version to use. Defaults to 2.17 when omitted.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

2 status codes
200Returns a paginated list of call objects, with the total count and pagination details.
typestringoptional
String representing the object's type. Always has the value `list`.
dataarray<Call>optional
A list of calls.
total_countintegeroptional
Total number of items available.
pagesobjectoptional
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.
401Returned when the request is unauthorized.

One documented failure

  • unauthorized

    Access Token Invalid

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects

Error handling

A 401 is returned when the request is unauthorized. per_page accepts a maximum of 25 results per page.