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 Location

REST Endpoint to use

US

https://api.intercom.io/

Europe

https://api.eu.intercom.io

Australia

https://api.au.intercom.io

The API is organized around the following resources:

API Area

Resource Area

Description

Contacts

https://api.intercom.io/contacts

Fetch, search, create, update and delete your contacts (users or leads).

Visitors

https://api.intercom.io/visitors

View, update and convert anonymous visitors on a website.

Companies

https://api.intercom.io/companies

Create and update Companies. List companies or access them individually.

Data Attributes

https://api.intercom.io/data_attributes

List attributes used to describe your customer and company models.

Tags

https://api.intercom.io/tags

Organise Users and your workspace Admins with tags.

Segments

https://api.intercom.io/segments

View your workspace's Segments.

Notes

https://api.intercom.io/notes

Create and view notes about Users.

Events

https://api.intercom.io/events

Use Events to submit User activity to Intercom

Counts

https://api.intercom.io/counts

Counts of Users and Companies by segment and tag. View open and closed counts for Admins.

Conversations

https://api.intercom.io/conversations

List conversations you have with users on your system. Allow Users and Admins to send messages and reply to conversations.

Messages

https://api.intercom.io/messages

Create and view Messages.

Admins

https://api.intercom.io/admins

View your workspace's teammates.

Teams

https://api.intercom.io/teams

View your workspace's teams.

Articles

https://api.intercom.io/articles

Create, retrieve, update, and delete articles.

Help Center

https://api.intercom.io/help_center

Create, retrieve, update, and delete Collections and Sections.

Common Approaches

The API uses common approaches for the following:

Function

Description

Data

API data is JSON encoded with UTF-8. API JSON is either a single object or a list of objects.

Errors

4xx and 5xx responses returning JSON with error codes.

Rate Limiting

Controls how many requests can be made in a time window.

HTTP

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


What’s Next

You can find all the detailed information on the API in the Reference, and find links for all all our supported SDKs & Client Libraries on the relevant pages.

Did this page help you?