Home
/
REST API Reference
/
Contacts
/
List all notes

List all notes

You can fetch a list of notes that are associated to a contact.

SecurityHTTP: bearerAuth
Request
path Parameters
id
required
integer

The unique identifier of a contact.

header Parameters
Intercom-Version
string (intercom_version)
Default: 2.10

Intercom API version.
By default, it's equal to the version set in the app package.

Enum: "1.0" "1.1" "1.2" "1.3" "1.4" "2.0" "2.1" "2.2" "2.3" "2.4" "2.5" "2.6" "2.7" "2.8" "2.9" "2.10" "Unstable"
Example: 2.10
get
/contacts/{id}/notes
Request samples
Responses
200
Successful response
Response Schema: application/json
type
string 
String representing the object's type. Always has the value list.
 
Array of objects (Note)  
An array of notes.
 
total_count
integer 
A count of the total number of notes.
 
object or null (Cursor based pages)  
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.
 
404
Contact not found
Response samples
application/json
{
"type": "list",
"data": [



],
"total_count": 3,
"pages": {
"type": "pages",
"next": null,
"page": 1,
"per_page": 50,
"total_pages": 1
}
}