List all contacts

You can fetch a list of all contacts (ie. users or leads) in your workspace.

Pagination

You can use pagination to limit the number of results returned. The default is 50 results per page. See the pagination section for more details on how to use the starting_after param.

SecurityHTTP: bearerAuth
Request
header Parameters
Intercom-Version
string (intercom_version)
Default: 2.11

Intercom API version.
By default, it's equal to the version set in the app package.

Enum: "1.0" "1.1" "1.2" "1.3" "1.4" "2.0" "2.1" "2.2" "2.3" "2.4" "2.5" "2.6" "2.7" "2.8" "2.9" "2.10" "2.11" "Unstable"
Example: 2.11
get
/contacts
Request samples
Responses

200

successful

Response Schema: application/json
type
string

Always list

Value: "list"
Array of objects (Contact)

The list of contact objects

total_count
integer

A count of the total number of objects.

object or null (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.

401

Unauthorized

Response samples
application/json
{ "type": "list", "data": [ ], "total_count": 0, "pages": { "type": "pages", "page": 1, "per_page": 10, "total_pages": 0 } }