The intercom API reference.
https://api.intercom.io/
https://api.eu.intercom.io/
https://api.au.intercom.io/
https://api.intercom.io/contacts/{contact_id}/companies/{company_id}
https://api.eu.intercom.io/contacts/{contact_id}/companies/{company_id}
https://api.au.intercom.io/contacts/{contact_id}/companies/{company_id}
curl -i -X DELETE \
https://api.intercom.io/contacts/58a430d35458202d41b1e65b/companies/58a430d35458202d41b1e65b \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Intercom-Version: 2.11'
Successful
The Intercom defined id representing the company.
The Intercom defined code of the workspace the company is associated to.
The time the company last recorded making a request.
The custom attributes you have set on the company.
{ "type": "company", "company_id": "1", "id": "667d60918a68186f43bafd80", "app_id": "this_is_an_id174_that_should_be_at_least_", "name": "company8", "remote_created_at": 1719492753, "created_at": 1719492753, "updated_at": 1719492753, "monthly_spend": 0, "session_count": 0, "user_count": 0, "tags": { "type": "tag.list", "tags": [] }, "segments": { "type": "segment.list", "segments": [] }, "plan": {}, "custom_attributes": {} }
https://api.intercom.io/contacts/{contact_id}/notes
https://api.eu.intercom.io/contacts/{contact_id}/notes
https://api.au.intercom.io/contacts/{contact_id}/notes
curl -i -X GET \
'https://api.intercom.io/contacts/{contact_id}/notes?page=1&per_page=15' \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Intercom-Version: 2.11'
Successful response
String representing the object's type. Always has the value list
.
An array of notes.
String representing the object's type. Always has the value note
.
Represents the contact that the note was created about.
Admins are teammate accounts that have access to a workspace.
String representing the object's type. Always has the value admin
.
Identifies if this admin is currently set in away mode.
Identifies if this admin is set to automatically reassign new conversations to the apps default inbox.
Identifies if this admin has a paid inbox seat to restrict/allow features that require them.
This object represents the avatar associated with the admin.
Image for the associated team or teammate
{ "type": "list", "data": [ { … }, { … }, { … } ], "total_count": 3, "pages": { "type": "pages", "next": null, "page": 1, "per_page": 50, "total_pages": 1 } }
https://api.intercom.io/contacts/{contact_id}/notes
https://api.eu.intercom.io/contacts/{contact_id}/notes
https://api.au.intercom.io/contacts/{contact_id}/notes
curl -i -X POST \
https://api.intercom.io/contacts/123/notes \
-H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
-H 'Content-Type: application/json' \
-H 'Intercom-Version: 2.11' \
-d '{
"contact_id": "667d60978a68186f43bafd9e",
"admin_id": 991267493,
"body": "Hello"
}'
Successful response
String representing the object's type. Always has the value note
.
Represents the contact that the note was created about.
Admins are teammate accounts that have access to a workspace.
String representing the object's type. Always has the value admin
.
Identifies if this admin is currently set in away mode.
Identifies if this admin is set to automatically reassign new conversations to the apps default inbox.
Identifies if this admin has a paid inbox seat to restrict/allow features that require them.
This object represents the avatar associated with the admin.
Image for the associated team or teammate
{ "type": "note", "id": "34", "created_at": 1719492759, "contact": { "type": "contact", "id": "667d60978a68186f43bafd9e" }, "author": { "type": "admin", "id": "991267493", "name": "Ciaran103 Lee", "email": "admin103@email.com", "away_mode_enabled": false, "away_mode_reassign": false }, "body": "<p>Hello</p>" }