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:
Users
https://api.intercom.io/users
Create and update Users. Use filters to get lists of Users, or access their profiles individually.
Leads
https://api.intercom.io/contacts
Create and update Leads. Get lists of Leads, or access their profiles individually.
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.
Admins
https://api.intercom.io/admins
View your workspace's teammates.
Teams
https://api.intercom.io/teams
View your workspace's teams.
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.
Updated 7 months ago
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 |