List attached companies for contact

Home

REST API Reference

Contacts

You can fetch a list of companies that are associated to a contact.

SecurityHTTP: bearerAuth

Request

path Parameters

required

string

The unique identifier for the contact which is given by Intercom

Example: 63a07ddf05a32042dffac965

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

/contacts/{id}/companies

Request samples

Responses

200

successful

Response Schema: application/json

type	string The type of object Value: "list"
	Array of objects (Company) An array containing Company Objects
total_count	integer The total number of companies associated to this contact
	object (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.

401

Unauthorized

404

Contact not found

Response samples
200
401
404
application/json
successful
{
"type": "list",
"data": [
{
"type": "company",
"company_id": "1",
"id": "660e72c36abd01bd27af6142",
"app_id": "this_is_an_id171_that_should_be_at_least_",
"name": "company12",
"remote_created_at": 1712222915,
"created_at": 1712222915,
"updated_at": 1712222915,
"last_request_at": 1712050115,
"monthly_spend": 0,
"session_count": 0,
"user_count": 1,
"tags": {
"type": "tag.list",
"tags": [ ]
},
"segments": {
"type": "segment.list",
"segments": [ ]
},
"plan": { },
"custom_attributes": { }
}
],
"pages": {
"type": "pages",
"next": null,
"page": 1,
"per_page": 50,
"total_pages": 1
},
"total_count": 1
}