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

The API is organized around the following resources:

API Area
Resource Area
Description

Users

Create and update Users. Use filters to get lists of Users, or access their profiles individually.

Leads

Create and update Leads. Get lists of Leads, or access their profiles individually.

Visitors

View, update and convert anonymous visitors on a website.

Companies

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

Data Attributes

List attributes used to describe your customer and company models.

Tags

Organise Users and your workspace Admins with tags.

Segments

View your workspace's Segments.

Notes

Create and view notes about Users.

Events

Use Events to submit User activity to Intercom

Counts

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

Conversations

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

Admins

View your workspace's teammates.

Teams

View your workspace's teams.

Common Approaches

The API uses common approaches for the following:

Function
Description

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

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

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

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.

REST API Reference
SDKs & Plugins