Example Request & Response
$ curl https://api.intercom.io/contacts/<id>/notes \
-H 'Authorization:Bearer <Your access token>' \
-H 'Accept:application/json'
HTTP/1.1 200 OK
{
"type": "note.list",
"data": [
{
"type": "note",
"id": "12345",
"created_at": 1569943728,
"user": {
"type": "user",
"id": "5ba682d23d7cf92bef87bfd4"
},
"author": {
"type": "admin",
"id": "12345",
"name": "Test",
"email": "[email protected]",
"away_mode_enabled": false,
"away_mode_reassign": false,
"avatar": {
"image_url": "https://test.test"
}
},
"body": "<p>test note</p>"
}
],
"pages": {
"type": "pages",
"next": null,
"page": 1,
"per_page": 20,
"total_pages": 1
},
"total_count": 1
}
Example Errors
HTTP/1.1 404 NOT FOUND
{
"type": "error.list",
"request_id": "9a3d0816-9707-4598-977e-c009ba630148",
"errors": [
{
"code": "not_found",
"message": "Contact Not Found"
}
]
}
You can fetch a list of notes 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 Note objects.
Attribute | Type | Description |
---|---|---|
type | String | The type of object - |
data | Array | An array containing Note Objects |
total_count | Integer | The total number of companies associated to this contact |
pages | The information needed to paginate through companies |