The intercom API reference.
The intercom API reference.
Notes allow you to annotate and comment on your contacts.
{ "type": "note", "id": "17495962", "created_at": 1674589321, "contact": { "type": "string", "id": "214656d0c743eafcfde7f248" }, "author": { "type": "admin", "id": "1295", "name": "Hoban Washburne", "email": "wash@serenity.io", "job_title": "Philosopher", "away_mode_enabled": false, "away_mode_reassign": false, "has_inbox_seat": true, "team_ids": [ … ], "avatar": "https://picsum.photos/200/300", "team_priority_level": { … } }, "body": "<p>Text for the note.</p>" }
curl -i -X GET \ 'https://api.intercom.io/contacts/{id}/notes' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Intercom-Version: 2.8'
Successful response
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.
{ "type": "list", "data": [ { … }, { … }, { … } ], "total_count": 3, "pages": { "type": "pages", "next": null, "page": 1, "per_page": 50, "total_pages": 1 } }
curl -i -X POST \ 'https://api.intercom.io/contacts/{id}/notes' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -H 'Intercom-Version: 2.8' \ -d '{ "contact_id": "6657a9786abd01639cc9e984", "admin_id": 991266840, "body": "Hello" }'
{ "type": "note", "id": "21", "created_at": 1717021048, "contact": { "type": "contact", "id": "6657a9786abd01639cc9e984" }, "author": { "type": "admin", "id": "991266840", "name": "Ciaran112 Lee", "email": "admin112@email.com", "away_mode_enabled": false, "away_mode_reassign": false }, "body": "<p>Hello</p>" }
curl -i -X GET \ 'https://api.intercom.io/notes/{id}' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Intercom-Version: 2.8'
{ "type": "note", "id": "24", "created_at": 1716330074, "contact": { "type": "contact", "id": "6657aa5a6abd01639cc9ea3e" }, "author": { "type": "admin", "id": "991267109", "name": "Ciaran323 Lee", "email": "admin323@email.com", "away_mode_enabled": false, "away_mode_reassign": false }, "body": "<p>This is a note.</p>" }