Intercom API (unofficial showcase)
GET/contacts

List contacts

Lists contacts in the workspace, including users and leads. Contacts merged into other contacts are excluded; only the destination contact remains in the list. Results are paginated, with 10 contacts per page by default and a maximum of 150 per page.

2 parameters
include_merge_historybooleanoptional
Set to true to include a `merge_history` array for contacts with a user role. Defaults to false when omitted.
Default:false
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 contact list with contact objects, a total count, and page details.
typestringoptional
Always list
Allowed:list
dataarray<Contact>optional
The list of contact objects
total_countintegeroptional
A count of the total number of objects.
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. Set include_merge_history to true to request merge history for contacts with a user role; it defaults to false when omitted.