Our REST API is a core building block of the Intercom Platform. You can use it to retrieve and update information from your own Intercom account, or to integrate Intercom into your own product. It's completely up to you and your custom use case.

Available Endpoints


API Endpoints for Regional Data Hosting Customers

For customers who are using Regional Data Hosting, the base URI for the API Endpoints are listed below. This replaces the start of the URIs for each REST API endpoint, to connect to the specific regions.

Regional Hosting LocationREST Endpoint to use

The API is organized around the following resources:

API AreaResource AreaDescription
Contacts, search, create, update and delete your contacts (users or leads).
Visitors, update and convert anonymous visitors on a website.
Companies and update Companies. List companies or access them individually.
Data Attributes attributes used to describe your customer and company models.
Tags Users and your workspace Admins with tags.
Segments your workspace's Segments.
Notes and view notes about Users.
Events Events to submit User activity to Intercom
Counts of Users and Companies by segment and tag. View open and closed counts for Admins.
Conversations conversations you have with users on your system. Allow Users and Admins to send messages and reply to conversations.
Messages and view Messages.
Admins your workspace's teammates.
Teams your workspace's teams.
Articles, retrieve, update, and delete articles.
Help Center, retrieve, update, and delete Collections and Sections.

Common Approaches

The API uses common approaches for the following:

DataAPI data is JSON encoded with UTF-8. API JSON is either a single object or a list of objects.
Errors4xx and 5xx responses returning JSON with error codes.
Rate LimitingControls how many requests can be made in a time window.
HTTPMethods are used in accordance with HTTP (GET POST and DELETE are the primary methods used) and resources are identified using URIs. All API requests are sent over HTTPS.