The intercom API reference.
Intercom API (2.11)
Download OpenAPI description
Overview
URL
License
Languages
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/
Paginated Response
A paginated list of notes associated with a contact.
String representing the object's type. Always has the value list.
Value"list"
Example: "list"
An array of notes.
String representing the object's type. Always has the value note.
Value"note"
Example: "note"
Represents the contact that the note was created about.
Admins are teammate accounts that have access to a workspace.
String representing the object's type. Always has the value admin.
Value"admin"
Example: "admin"
Identifies if this admin is currently set in away mode.
Example: false
Identifies if this admin is set to automatically reassign new conversations to the apps default inbox.
Example: false
Identifies if this admin has a paid inbox seat to restrict/allow features that require them.
Example: true
This object represents the avatar associated with the admin.
Example: [814865]
Image for the associated team or teammate
Example: "https://picsum.photos/200/300"
{ "type": "list", "data": [ { … } ], "total_count": 1, "pages": { "type": "pages", "page": 1, "next": { … }, "per_page": 2, "total_pages": 13 } }
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.
A link to the next page of results. A response that does not contain a next link does not have further data to fetch.
{ "type": "pages", "page": 1, "next": "http://example.com", "per_page": 50, "total_pages": 1 }