Unfortunately, this feature is not supported on mobile devices. For the best experience, please use a computer.
Home
/
REST API Reference
/
Notes

Intercom API (2.11)

The intercom API reference.

Download OpenAPI description
api.intercom.io.json
api.intercom.io.yaml
Overview
URL https://developers.intercom.com
License MIT
Languages
Servers
Mock server
https://developers.intercom.com/_mock/docs/references/rest-api/api.intercom.io/
The production API server
https://api.intercom.io/
The european API server
https://api.eu.intercom.io/
The australian API server
https://api.au.intercom.io/

Admins

Everything about your Admins

Operations

Articles

Everything about your Articles

Operations

Companies

Everything about your Companies

Operations

Contacts

Everything about your contacts

Operations

Conversations

Everything about your Conversations

Operations

Data Attributes

Everything about your Data Attributes

Operations

Data Events

Everything about your Data Events

Operations

Data Export

Everything about your Data Exports

Operations

Help Center

Everything about your Help Center

Operations

Messages

Everything about your messages

Operations

News

Everything about your News

Operations

Notes

Everything about your Notes

Operations

Note

Notes allow you to annotate and comment on your contacts.

typestring

String representing the object's type. Always has the value note.

Example:

"note"

idstring

The id of the note.

Example:

"17495962"

created_atinteger(timestamp)

The time the note was created.

Example:

1674589321

contactobject or null

Represents the contact that the note was created about.

authorobject or null(Admin)

Admins are teammate accounts that have access to a workspace.

bodystring

The body text of the note.

Example:

"<p>Text for the note.</p>"

{
  "type": "note",
  "id": "17495962",
  "created_at": 1674589321,
  "contact": {
    "type": "string",
    "id": "214656d0c743eafcfde7f248"
  },
  "author": {
    "type": "admin",
    "id": "1295",
    "name": "Hoban Washburne",
    "email": "wash@serenity.io",
    "job_title": "Philosopher",
    "away_mode_enabled": false,
    "away_mode_reassign": false,
    "has_inbox_seat": true,
    "team_ids": [ … ],
    "avatar": "https://picsum.photos/200/300",
    "team_priority_level": { … }
  },
  "body": "<p>Text for the note.</p>"
}

List all notes

Request

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

Path
idintegerrequired

The unique identifier of a contact.

Headers
Intercom-Versionstring(intercom_version)

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

Default 2.11
Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"
Example:

2.11

curl -i -X GET \
  'https://developers.intercom.com/_mock/docs/references/rest-api/api.intercom.io/contacts/{id}/notes' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: 2.11'
Experience it firsthand in the API Explorer!

Responses

Successful response

Bodyapplication/json
typestring

String representing the object's type. Always has the value list.

Example:

"list"

dataArray of objects(Note)

An array of notes.

total_countinteger

A count of the total number of notes.

Example:

1

pagesobject 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.

Response
application/json
{
  "type": "list",
  "data": [
    { … },
    { … },
    { … }
  ],
  "total_count": 3,
  "pages": {
    "type": "pages",
    "next": null,
    "page": 1,
    "per_page": 50,
    "total_pages": 1
  }
}

Create a note

Request

You can add a note to a single contact.

Path
idintegerrequired

The unique identifier of a given contact.

Example:

123

Headers
Intercom-Versionstring(intercom_version)

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

Default 2.11
Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"
Example:

2.11

Bodyapplication/json
bodystringrequired

The text of the note.

Example:

"New note"

contact_idstring

The unique identifier of a given contact.

Example:

"123"

admin_idstring

The unique identifier of a given admin.

Example:

"123"

curl -i -X POST \
  'https://developers.intercom.com/_mock/docs/references/rest-api/api.intercom.io/contacts/{id}/notes' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Intercom-Version: 2.11' \
  -d '{
    "contact_id": "667d60978a68186f43bafd9e",
    "admin_id": 991267493,
    "body": "Hello"
  }'
Experience it firsthand in the API Explorer!

Responses

Successful response

Bodyapplication/json
typestring

String representing the object's type. Always has the value note.

Example:

"note"

idstring

The id of the note.

Example:

"17495962"

created_atinteger(timestamp)

The time the note was created.

Example:

1674589321

contactobject or null

Represents the contact that the note was created about.

authorobject or null(Admin)

Admins are teammate accounts that have access to a workspace.

bodystring

The body text of the note.

Example:

"<p>Text for the note.</p>"

Response
application/json
{
  "type": "note",
  "id": "34",
  "created_at": 1719492759,
  "contact": {
    "type": "contact",
    "id": "667d60978a68186f43bafd9e"
  },
  "author": {
    "type": "admin",
    "id": "991267493",
    "name": "Ciaran103 Lee",
    "email": "admin103@email.com",
    "away_mode_enabled": false,
    "away_mode_reassign": false
  },
  "body": "<p>Hello</p>"
}

Retrieve a note

Request

You can fetch the details of a single note.

Path
idintegerrequired

The unique identifier of a given note

Example:

1

Headers
Intercom-Versionstring(intercom_version)

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

Default 2.11
Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"
Example:

2.11

curl -i -X GET \
  'https://developers.intercom.com/_mock/docs/references/rest-api/api.intercom.io/notes/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: 2.11'
Experience it firsthand in the API Explorer!

Responses

Note found

Bodyapplication/json
typestring

String representing the object's type. Always has the value note.

Example:

"note"

idstring

The id of the note.

Example:

"17495962"

created_atinteger(timestamp)

The time the note was created.

Example:

1674589321

contactobject or null

Represents the contact that the note was created about.

authorobject or null(Admin)

Admins are teammate accounts that have access to a workspace.

bodystring

The body text of the note.

Example:

"<p>Text for the note.</p>"

Response
application/json
{
  "type": "note",
  "id": "37",
  "created_at": 1718801789,
  "contact": {
    "type": "contact",
    "id": "667d617d8a68186f43bafe58"
  },
  "author": {
    "type": "admin",
    "id": "991267764",
    "name": "Ciaran316 Lee",
    "email": "admin316@email.com",
    "away_mode_enabled": false,
    "away_mode_reassign": false
  },
  "body": "<p>This is a note.</p>"
}

Segments

Everything about your Segments

Operations

Subscription Types

Everything about subscription types

Operations

Switch

Everything about Switch

Operations

Tags

Everything about tags

Operations

Teams

Everything about your Teams

Operations

Ticket Type Attributes

Everything about your ticket type attributes

Operations

Ticket Types

Everything about your ticket types

Operations

Tickets

Everything about your tickets

Operations

Visitors

Everything about your Visitors

Operations

Models