Intercom API (unofficial showcase)
GET/companies/{company_id}/notes

List notes for a company

Lists the notes associated with a specific company. Use the company identifier to retrieve its notes; the response includes cursor-based pagination metadata.

2 parameters
company_idstringrequired
The unique identifier of the company whose notes you want to list.
Intercom-Versionstringoptional
API version to use for the request. Defaults to 2.17 when omitted.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

2 status codes
200Returns a list of notes associated with the company, along with the total note count and cursor-based pagination metadata.
typestringoptional
String representing the object's type. Always has the value `list`.
dataarray<Note>optional
An array of notes.
total_countintegeroptional
A count of the total number of notes.
pagesobjectoptional
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.
404Returned when the company does not exist.

One documented failure

  • company_not_found

    Company Not Found

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

Error handling

A 404 is returned when the company_id path parameter does not identify an existing company. The Intercom-Version header selects the API version and defaults to 2.17 when omitted.