List attached companies
Example Request & Response
$ curl https://api.intercom.io/contacts/<id>/companies \\\n-H 'Authorization:Bearer <Your access token>' \\\n-H 'Accept:application/json'
Example Errors
Contact not found
HTTP/1.1 404 NOT FOUND\n{\n \"type\": \"error.list\",\n \"request_id\": \"9a3d0816-9707-4598-977e-c009ba630148\",\n \"errors\": [\n {\n \"code\": \"not_found\",\n \"message\": \"Contact Not Found\"\n }\n ]\n}
You can fetch a list of companies that are associated to a contact.
Request Path Parameter
| Parameter | Type | Required | Description |
|---|---|---|---|
| id | String | Yes | The unique identifier for the contact which is given by Intercom |
Response
This will return a paginated list of Company objects.
| Attribute | Type | Description |
|---|---|---|
| type | String | The type of object - company.list |
| companies | Array | An array containing Company Objects |
| total_count | Integer | The total number of companies associated to this contact |
| pages | Pagination Object | The information needed to paginate through companies |