REST API Reference

Intercom API (2.13)

The Intercom API reference.

Download OpenAPI description

api.intercom.io.json

api.intercom.io.yaml

Overview

URL

https://developers.intercom.com

License

MIT

Servers

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

AI Content

With the AI Content APIs, you can create and manage External Pages and Content Import Sources for your Fin Content Library.

External Pages are pages that you want Fin to be able to answer questions about. The API for External Pages is a great way to ingest into your Fin Content Library pages that are not publicly accessible and hence can't be crawled by Intercom.

Content Import Sources are the sources of those pages, and they are used to determine the default audience for the pages (configured via the UI). You should create a Content Import Source for each source of External Pages that you want to ingest into your Fin Content Library.

You can then iterate through the content from that source via its API and POST it to the External Pages endpoint. That endpoint has an external_id parameter which allows you to specify the identifier from the source. The endpoint will then either create a new External Page or update an existing one as appropriate.",

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

Custom Object Instances

Everything about your Custom Object instances.

Permission Requirements

From now on, to access this endpoint, you need additional permissions. Please head over to the Developer Hub app package authentication settings to configure the required permissions.

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: "Text for the note."

{
  "type": "note",
  "id": "17495962",
  "created_at": 1674589321,
  "contact": {
    "type": "string",
    "id": "214656d0c743eafcfde7f248"
  },
  "author": {
    "type": "admin",
    "id": "1295",
    "name": "Joe Example",
    "email": "jdoe@example.com",
    "job_title": "Associate",
    "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.13

Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"

Example: 2.13

curl -i -X GET \
  'https://api.intercom.io/contacts/{id}/notes' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: 2.13'

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

Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"

Example: 2.13

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://api.intercom.io/contacts/123/notes \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Intercom-Version: 2.13' \
  -d '{
    "contact_id": "677c552b6abd011ad17ff4d1",
    "admin_id": 991266338,
    "body": "Hello"
  }'

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: "Text for the note."

Response

application/json

{
  "type": "note",
  "id": "8",
  "created_at": 1736201515,
  "contact": {
    "type": "contact",
    "id": "677c552b6abd011ad17ff4d1"
  },
  "author": {
    "type": "admin",
    "id": "991266338",
    "name": "Ciaran124 Lee",
    "email": "admin124@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.13

Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"

Example: 2.13

curl -i -X GET \
  https://api.intercom.io/notes/1 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: 2.13'

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: "Text for the note."

Response

application/json

{
  "type": "note",
  "id": "11",
  "created_at": 1735510657,
  "contact": {
    "type": "contact",
    "id": "677c56816abd011ad17ff58c"
  },
  "author": {
    "type": "admin",
    "id": "991266617",
    "name": "Ciaran344 Lee",
    "email": "admin344@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

Teams

Everything about your Teams

Operations

Ticket States

Everything about your ticket states

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

Intercom API (2.13)

Admins

AI Content

Articles

Companies

Contacts

Conversations

Custom Object Instances

Data Attributes

Data Events

Data Export

Help Center

Messages

News

Notes

Note

List all notes

Request

Responses

Was this page helpful?

Create a note

Request

Responses

Was this page helpful?

Retrieve a note

Request

Responses

Was this page helpful?

Segments

Subscription Types

Switch

Tags

Teams

Ticket States

Ticket Type Attributes

Ticket Types

Tickets

Visitors

Models