The API is organized around the following resources -
| API Area | Resource Area | Description |
|---|---|---|
| Users | https://api.intercom.io/users | Create and update Users. Use filters to get lists of Users, or access their profiles individually. |
| Companies | https://api.intercom.io/companies | Create and update Companies. List companies or access them individually. |
| Leads | https://api.intercom.io/contacts | Create and update Leads. Get lists of Leads, or access their profiles individually. |
| Admins | https://api.intercom.io/admins | View your App's Admins. |
| Tags | https://api.intercom.io/tags | Organise Users and your App Admins with tags. |
| Segments | https://api.intercom.io/segments | View your App'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 (only available on some plans). |
JSON is returned in all responses.
The API also 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. |
| Authorization | Access control using API Access Tokens. |
| 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. |