Home
/
REST API Reference
/
Notes
/
Retrieve a note

Retrieve a note

You can fetch the details of a single note.

SecurityHTTP: bearerAuth
Request
path Parameters
id
required
integer

The unique identifier of a given note

Example: 1
header Parameters
Intercom-Version
string (intercom_version)
Default: 2.11

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" "2.11" "Unstable"
Example: 2.11
get
/notes/{id}
Request samples
Responses
200
Note found
Response Schema: application/json
type
string 
String representing the object's type. Always has the value note.
 
id
string 
The id of the note.
 
created_at
integer <timestamp>  
The time the note was created.
 
object or null 
Represents the contact that the note was created about.
 
object or null (Admin)  
Admins are teammate accounts that have access to a workspace.
 
body
string 
The body text of the note.
 
401
Unauthorized
404
Note not found
Response samples
application/json
{
"type": "note",
"id": "141",
"created_at": 1714386802,
"contact": {
"type": "contact",
"id": "663a0372262d16a19645eece"
},
"author": {
"type": "admin",
"id": "991271848",
"name": "Ciaran316 Lee",
"email": "admin316@email.com",
"away_mode_enabled": false,
"away_mode_reassign": false
},
"body": "<p>This is a note.</p>"
}