Home
/
REST API Reference
/
Contacts
/
List attached contacts

List attached contacts

You can fetch a list of all contacts that belong to a company.

SecurityHTTP: bearerAuth
Request
path Parameters
id
required
string

The unique identifier for the company which is given by Intercom

Example: 5f4d3c1c-7b1b-4d7d-a97e-6095715c6632
header Parameters
Intercom-Version
string (intercom_version)
Default: 2.10

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" "Unstable"
Example: 2.10
get
/companies/{id}/contacts
Request samples
Responses
200
Successful
Response Schema: application/json
type
string 
The type of object - list
 Value: "list"  
Array of objects (Contact)  
An array containing Contact Objects
 
total_count
integer 
The total number of contacts
 
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
404
Company Not Found
Response samples
application/json
{
"type": "list",
"data": [ ],
"total_count": 0,
"pages": {
"type": "pages",
"page": 1,
"per_page": 50,
"total_pages": 0
}
}