Intercom API (unofficial showcase)
GET/notes/{note_id}

Get a note

Retrieves a note attached to a contact or company. Supply note_id to identify the note. The response includes the note body, creation time, author, and associated contact or company.

2 parameters
note_idintegerrequired
The unique integer identifier of the note to retrieve.
Intercom-Versionstringoptional
The Intercom API version to use. Defaults to 2.17 when omitted; supported values include the versions listed in the schema.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

3 status codes
200Returns the note object, including its identifier, creation time, body, author, and associated contact or company.
typestringoptional
String representing the object's type. Always has the value `note`.
idstringoptional
The id of the note.
created_atintegeroptional
The time the note was created.
contactobjectoptional
Represents the contact that the note was created about.
companyobjectoptional
Represents the company that the note was created about.
authorobjectoptional
Admins are teammate accounts that have access to a workspace.
bodystringoptional
The body text of the note.
401Returned when the request is unauthorized.

One documented failure

  • unauthorized

    Access Token Invalid

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects
404Returned when the requested note does not exist.

One documented failure

  • not_found

    Resource Not Found

typestringrequired
The type is error.list
request_idstringoptional
errorsarray<object>required
An array of one or more error objects

Error handling

A 401 is returned when the request is unauthorized; send valid API credentials. A 404 is returned when no note exists with the specified note_id path parameter.