Open Conversation Request

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

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

Paginated Response

A paginated list of notes associated with a contact.

typestringrequired

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

Value"list"

Example: "list"

dataArray of objects(Note)required

An array of notes.

data[].typestringrequired

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

Value"note"

Example: "note"

data[].idstringrequired

The id of the note.

Example: "17495962"

data[].created_atinteger(timestamp)required

The time the note was created.

Example: 1674589321

data[].contactobject or nullrequired

Represents the contact that the note was created about.

data[].contact.typestring

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

Value"contact"

data[].contact.idstring

The id of the contact.

Example: "214656d0c743eafcfde7f248"

data[].authorobject(Admin)required

Admins are teammate accounts that have access to a workspace.

data[].author.typestring

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

Value"admin"

Example: "admin"

data[].author.idstringrequired

The id representing the admin.

Example: "1295"

data[].author.namestringrequired

The name of the admin.

Example: "Hoban Washburne"

data[].author.emailstringrequired

The email of the admin.

Example: "wash@serenity.io"

data[].author.job_titlestringrequired

The job title of the admin.

Example: "Philosopher"

data[].author.away_mode_enabledbooleanrequired

Identifies if this admin is currently set in away mode.

Example: false

data[].author.away_mode_reassignbooleanrequired

Identifies if this admin is set to automatically reassign new conversations to the apps default inbox.

Example: false

data[].author.has_inbox_seatbooleanrequired

Identifies if this admin has a paid inbox seat to restrict/allow features that require them.

Example: true

data[].author.team_idsArray of integersrequired

This object represents the avatar associated with the admin.

Example: [814865]

data[].author.avatarstring or null(uri)

Image for the associated team or teammate

Example: "https://picsum.photos/200/300"

data[].author.team_priority_levelobject(Team Priority Level)

Admin priority levels for teams

data[].bodystringrequired

The body text of the note.

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

total_countintegerrequired

A count of the total number of notes.

Example: 1

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

{
  "type": "list",
  "data": [
    { … }
  ],
  "total_count": 1,
  "pages": {
    "type": "pages",
    "page": 1,
    "next": { … },
    "per_page": 2,
    "total_pages": 13
  }
}

Open Conversation Request

Payload of the request to open a conversation

message_typestringrequired

Value"open"

Example: "open"

admin_idstringrequired

The id of the admin who is performing the action.

Example: "5017690"

{
  "message_type": "open",
  "admin_id": "5017690"
}

Pagination Object

The majority of list resources in the API are paginated to allow clients to traverse data over multiple requests.

Their responses are likely to contain a pages object that hosts pagination links which a client can use to paginate through the data without having to construct a query. The link relations for the pages field are as follows.

typestringrequired

Value"pages"

Example: "pages"

pageintegerrequired

Example: 1

nextstring or null(uri)

A link to the next page of results. A response that does not contain a next link does not have further data to fetch.

per_pageintegerrequired

Example: 50

total_pagesintegerrequired

Example: 1

{
  "type": "pages",
  "page": 1,
  "next": "http://example.com",
  "per_page": 50,
  "total_pages": 1
}

Intercom API (2.11)

Admins

Articles

Companies

Contacts

Conversations

Data Attributes

Data Events

Data Export

Help Center

Messages

News

Notes

Segments

Subscription Types

Switch

Tags

Teams

Ticket Type Attributes

Ticket Types

Tickets

Visitors

Models

Paginated Response

Open Conversation Request

Pagination Object