GET/contacts/{contact_id}/companies

List companies attached to a contact

Lists the companies associated with a specific contact. Use the contact identifier to retrieve its attached companies; the response includes pagination metadata.

2 parameters
contact_idstringrequired
The unique identifier of the contact whose attached companies you want to list.
Intercom-Versionstringoptional
API version to use for the request. Defaults to 2.17 when omitted.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

3 status codes
200Returns a list of company objects associated with the contact, the total company count, and pagination metadata.
typestringoptional
The type of object
Allowed:list
companiesarray<Company>optional
An array containing Company Objects
total_countintegeroptional
The total number of companies associated to this contact
pagesobjectoptional
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.
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
404Returned when the contact does not exist.

One documented failure

  • not_found

    User Not Found

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. A 404 is returned when the contact_id path parameter does not identify an existing contact.