Admins

Articles

The Intercom defined code of the workspace the company is associated to.

The company id you have defined for the company.

The time the company was added in Intercom.

The custom attributes you have set on the company.

The Intercom defined id representing the company.

The industry that the company operates in.

The time the company last recorded making a request.

How much revenue the company generates for your business.

The list of segments associated with the company

How many sessions the company has recorded.

Companies

Contacts

Conversations

Notes

Segments

Teams

Ticket Types

Tickets

Intercom


You can view the currently authorised admin along with the embedded app object (a "workspace" in legacy terminology).

> 🚧 Single Sign On
>
> If you are building a custom "Log in with Intercom" flow for your site, and you call the `/me` endpoint to identify the logged-in user, you should not accept any sign-ins from users with unverified email addresses as it poses a potential impersonation security risk.


Identify an admin

You can get a log of activities by all admins in an app.

List all activity logs

You can fetch a list of admins for a given workspace.

List all admins

You can retrieve the details of a single admin.

Retrieve an admin

You can set an Admin as away for the Inbox.

Set an admin to away

You can fetch a list of all articles by making a GET request to `https://api.intercom.io/articles`.

> 📘 How are the articles sorted and ordered?
>
> Articles will be returned in descending order on the `updated_at` attribute. This means if you need to iterate through results then we'll show the most recently updated articles first.


List all articles

You can create a new article by making a POST request to `https://api.intercom.io/articles`.

Create an article

You can fetch the details of a single article by making a GET request to `https://api.intercom.io/articles/<id>`.

Retrieve an article

You can update the details of a single article by making a PUT request to `https://api.intercom.io/articles/<id>`.

Update an article

You can delete a single article by making a DELETE request to `https://api.intercom.io/articles/<id>`.

Delete an article

You can fetch a company by either passing in `company_id` or `name` as a query parameter.

A company can also be fetched by its name using a name or company_id parameter in the url, whose values are the ones you have defined for that company -
  `https://api.intercom.io/companies?name={name}`
  `https://api.intercom.io/companies?company_id={company_id}`


Retrieve a company

You can create or update a company.

> 📘 Companies with no users
>
> Companies will be only visible in Intercom when there is at least one associated user.

Companies are looked up via `company_id` in a `POST` request, if not found via `company_id`, the new company will be created, if found, that company will be updated.


Create or Update a company

Retrieve a company by ID

Update a company

Delete a company

You can fetch a list of all contacts that belong to a company.

List attached contacts

You can fetch a list of all segments that belong to a company.

List attached segments for companies

      The `list all companies` functionality does not work well for huge datasets, and can result in errors and performance problems when paging deeply. The Scroll API provides an efficient mechanism for iterating over all companies in a dataset.

- Each app can only have 1 scroll open at a time. You'll get an error message if you try to have more than one open per app.
- If the scroll isn't used for 1 minute, it expires and calls with that scroll param will fail
- If the end of the scroll is reached, "companies" will be empty and the scroll parameter will expire

> 📘 Scroll Parameter
>
> You can get the first page of companies by simply sending a GET request to the scroll endpoint. For subsequent requests you will need to use the scroll parameter from the response.

> ❗️ Scroll network timeouts
>
> Since scroll is often used on large datasets network errors such as timeouts can be encountered. When this occurs you will need to restart your scroll query as it is not possible to continue from a specific point when using scroll.
>
> When this occurs you will see a HTTP 500 error with the following message:
> "Request failed due to an internal network error. Please restart the scroll operation."


Scroll over all companies

You can list companies. The company list is sorted by the `last_request_at` field and by default is ordered descending, most recently requested first.

Note that the API does not include companies who have no associated users in list responses.

> 📘
>
> When using the Companies endpoint and the pages object to iterate through the returned companies, there is a limit of 10,000 Companies that can be returned. If you need to list or iterate on more than 10,000 Companies, please use the [Scroll API](https://developers.intercom.com/reference#iterating-over-all-companies).


List all companies

You can attach a company to a single contact.

Attach a Contact to a Company

You can detach a company from a single contact.

Detach a contact from a company

You can fetch a list of companies that are associated to a contact.

List attached companies for contact

You can fetch a list of segments that are associated to a contact.

List attached segments for contact

You can fetch a list of subscription types that are attached to a contact. These can be subscriptions that a user has 'opted-in' to or has 'opted-out' from, depending on the subscription type.
This will return a list of Subscription Type objects that the contact is associated with.

The data property will show a combined list of:

  1.Opt-out subscription types that the user has opted-out from.
  2.Opt-in subscription types that the user has opted-in to receiving.


List subscriptions for a contact

You can add a specific subscription to a contact. In Intercom, we have two different subscription types based on user consent - opt-out and opt-in:

  1.Attaching a contact to an opt-out subscription type will opt that user out from receiving messages related to that subscription type.

  2.Attaching a contact to an opt-in subscription type will opt that user in to receiving messages related to that subscription type.

This will return a subscription type model for the subscription type that was added to the contact.


Add subscription to a contact

You can fetch a list of all tags that are attached to a specific contact.

List tags attached to a contact

You can tag a specific contact. This will return a tag object for the tag that was added to the contact.

Add tag to a contact

You can fetch the details of a single contact.

Get a contact

You can update an existing contact (ie. user or lead).

Update a contact

Delete a contact

List all contacts

You can create a new contact (ie. user or lead).

Create contact

You can merge a contact with a `role` of `lead` into a contact with a `role` of `user`.

Merge a lead and a user

You can search for multiple contacts by the value of their attributes in order to fetch exactly who you want.

To search for contacts, you need to send a POST request to `https://api.intercom.io/contacts/search`. This will accept a query object in the body which will define your filters in order to search for contacts.

> 🚧 Why is there a delay when creating contacts and searching for them?
>
> If a contact has recently been created, there is a possibility that it will not yet be available when searching. This means that it may not appear in the response. This delay can take a few minutes. If you need to be instantly notified then you could use webhooks instead, which you'd currently have to iterate on to see if they match your search filters.

> 🚧 Nesting & Limitations
>
> You can nest these filters in order to get even more granular insights that pinpoint exactly what you need. Example: (1 OR 2) AND (3 OR 4).
> There are some limitations to the amount of multiple's there can be:
> * There's a limit of max 2 nested filters
> * There's a limit of max 15 filters for each AND or OR group

> 🚧 Searching for Timestamp Fields

> All timestamp fields (created_at, updated_at etc.) are indexed as Dates for Contact Search queries; Datetime queries are not currently supported. This means you can only query for timestamp fields by day - not hour, minute or second.
> For example, if you search for all Contacts with a created_at value greater (>) than 1577869200 (the UNIX timestamp for January 1st, 2020 9:00 AM), that will be interpreted as 1577836800 (January 1st, 2020 12:00 AM). The search results will then include Contacts created from January 2nd, 2020 12:00 AM onwards.
> If you'd like to get contacts created on January 1st, 2020 you should search with a created_at value equal (=) to 1577836800 (January 1st, 2020 12:00 AM).
> This behaviour applies only to timestamps used in search queries. The search results will still contain the full UNIX timestamp and be sorted accordingly.

### Accepted Fields

Most key listed as part of the Contacts Model are searchable, whether writeable or not. The value you search for has to match the accepted type, otherwise the query will fail (ie. as `created_at` accepts a date, the `value` cannot be a string such as `"foorbar"`).

| Field                              | Type                           |
| ---------------------------------- | ------------------------------ |
| id                                 | String                         |
| role                               | String<br>Accepts user or lead |
| name                               | String                         |
| avatar                             | String                         |
| owner_id                           | Integer                        |
| email                              | String                         |
| phone                              | String                         |
| external_id                        | String                         |
| created_at                         | Date (UNIX Timestamp)          |
| signed_up_at                       | Date (UNIX Timestamp)          |
| updated_at                         | Date (UNIX Timestamp)          |
| last_seen_at                       | Date (UNIX Timestamp)          |
| last_contacted_at                  | Date (UNIX Timestamp)          |
| last_replied_at                    | Date (UNIX Timestamp)          |
| last_email_opened_at               | Date (UNIX Timestamp)          |
| last_email_clicked_at              | Date (UNIX Timestamp)          |
| language_override                  | String                         |
| browser                            | String                         |
| browser_language                   | String                         |
| os                                 | String                         |
| location.country                   | String                         |
| location.region                    | String                         |
| location.city                      | String                         |
| unsubscribed_from_emails           | Boolean                        |
| marked_email_as_spam               | Boolean                        |
| has_hard_bounced                   | Boolean                        |
| ios_last_seen_at                   | Date (UNIX Timestamp)          |
| ios_app_version                    | String                         |
| ios_device                         | String                         |
| ios_app_device                     | String                         |
| ios_os_version                     | String                         |
| ios_app_name                       | String                         |
| ios_sdk_version                    | String                         |
| android_last_seen_at               | Date (UNIX Timestamp)          |
| android_app_version                | String                         |
| android_device                     | String                         |
| android_app_name                   | String                         |
| andoid_sdk_version                 | String                         |
| segment_id                         | String                         |
| tag_id                             | String                         |
| custom_attributes.{attribute_name} | String                         |



Search contacts

Archive contact

Unarchive contact

You can fetch a list of all conversations.

You can optionally request the result page size and the cursor to start after to fetch the result


List all conversations

You can create a conversation that has been initiated by a contact (ie. user or lead).
The conversation can be an in-app message only.

> 📘 Sending for visitors
>
> You can also send a message from a visitor by specifying their `user_id` or `id` value in the `from` field, along with a `type` field value of `contact`.
> This visitor will be automatically converted to a contact with a lead role once the conversation is created.

This will return the Message model that has been created.



Creates a conversation


You can fetch the details of a single conversation.

This will return a single Conversation model with all its conversation parts.

> 🚧 Hard limit of 500 parts
>
> The maximum number of conversation parts that can be returned via the API is 500. If you have more than that we will return the 500 most recent conversation parts.



Retrieve a conversation


You can update an existing conversation.

> 📘
>
> If you want to update a conversation with either a reply (or actions such as assign, unassign, open, close or snooze) then take a look at their own sections respectively as they currently require different endpoints and parameters.



Update a conversation

Search conversations

You can reply to a conversation with a message from an admin or on behalf of a contact, or with a note for admins.

Reply to a conversation

You can close a conversation.
You can snooze a conversation to reopen on a future date.
You can open a conversation which is `snoozed` or `closed`.
You can assign a conversation to an admin and/or team.


Manage a conversation

You can let a conversation be automatically assigned following assignment rules.

Run Assignment Rules on a conversation

You can add participants who are contacts to a conversation, on behalf of either another contact or an admin.

> 🚧 Note about contacts without an email
>
> If you add a contact via the email parameter and there is no user/lead found on that workspace with he given email, then we will create a new contact with `role` set to `lead`.



Attach a contact to a conversation

You can redact a conversation part or the source message of a conversation (as seen in the source object).

> 📘 Which parts and source messages can I redact?
>
> If you are redacting a conversation part, it must have a `body`.
> If you are redacting a source message, it must have been created by a contact.
> We will return a `conversation_part_not_redactable` error if these criteria are not met.



Redact a conversation part

Detach a contact from a group conversation

You can fetch a list of all data attributes belonging to a workspace for contacts, companies or conversations.

List all data attributes

You can create a data attributes for a `contact` or a `company`.

Create a data attribute


You can update a data attribute.

> 🚧 Updating the data type is not possible
>
> It is currently a dangerous action to execute changing a data attribute's type via the API. You will need to update the type via the UI instead.


Update a data attribute


> 🚧
>
> Please note that you can only 'list' events that are less than 90 days old. Event counts and summaries will still include your events older than 90 days but you cannot 'list' these events individually if they are older than 90 days

The events belonging to a customer can be listed by sending a GET request to `https://api.intercom.io/events` with a user or lead identifier along with a `type` parameter. The identifier parameter can be one of `user_id`, `email` or `intercom_user_id`. The `type` parameter value must be `user`.

- `https://api.intercom.io/events?type=user&user_id={user_id}`
- `https://api.intercom.io/events?type=user&email={email}`
- `https://api.intercom.io/events?type=user&intercom_user_id={id}` (this call can be used to list leads)

The `email` parameter value should be [url encoded](http://en.wikipedia.org/wiki/Percent-encoding) when sending.

You can optionally define the result page size as well with the `per_page` parameter.


List all data events


You will need an Access Token that has write permissions to send Events. Once you have a key you can submit events via POST to the Events resource, which is located at https://api.intercom.io/events, or you can send events using one of the client libraries. When working with the HTTP API directly a client should send the event with a `Content-Type` of `application/json`.

When using the JavaScript API, [adding the code to your app](http://docs.intercom.io/configuring-Intercom/tracking-user-events-in-your-app) makes the Events API available. Once added, you can submit an event using the `trackEvent` method. This will associate the event with the Lead or currently logged-in user or logged-out visitor/lead and send it to Intercom. The final parameter is a map that can be used to send optional metadata about the event.

With the Ruby client you pass a hash describing the event to `Intercom::Event.create`, or call the `track_user` method directly on the current user object (e.g. `user.track_event`).

| Type            | Description                                                                                                                                                                                                     | Example                                                                           |
| :-------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------- |
| String          | The value is a JSON String                                                                                                                                                                                      | `"source":"desktop"`                                                              |
| Number          | The value is a JSON Number                                                                                                                                                                                      | `"load": 3.67`                                                                    |
| Date            | The key ends with the String `_date` and the value is a [Unix timestamp](http://en.wikipedia.org/wiki/Unix_time), assumed to be in the [UTC](http://en.wikipedia.org/wiki/Coordinated_Universal_Time) timezone. | `"contact_date": 1392036272`                                                      |
| Link            | The value is a HTTP or HTTPS URI.                                                                                                                                                                               | `"article": "https://example.org/ab1de.html"`                                     |
| Rich Link       | The value is a JSON object that contains `url` and `value` keys.                                                                                                                                                | `"article": {"url": "https://example.org/ab1de.html", "value":"the dude abides"}` |
| Monetary Amount | The value is a JSON object that contains `amount` and `currency` keys. The `amount` key is a positive integer representing the amount in cents. The price in the example to the right denotes €349.99.          | `"price": {"amount": 34999, "currency": "eur"}`                                   |

**NB: For the JSON object types, please note that we do not currently support nested JSON structure.**

> 🚧 Lead Events
>
> When submitting events for Leads, you will need to specify the Lead's `id`.

> 📘 Metadata behaviour
>
> - We currently limit the number of tracked metadata keys to 10 per event. Once the quota is reached, we ignore any further keys we receive. The first 10 metadata keys are determined by the order in which they are sent in with the event.
> - It is not possible to change the metadata keys once the event has been sent. A new event will need to be created with the new keys and you can archive the old one.
> - There might be up to 24 hrs delay when you send a new metadata for an existing event.

> 📘 Event de-duplication
>
> The API may detect and ignore duplicate events. Each event is uniquely identified as a combination of the following data - the Workspace identifier, the Contact external identifier, the Data Event name and the Data Event created time. As a result, it is **strongly recommended** to send a second granularity Unix timestamp in the `created_at` field.
>
> Duplicated events are responded to using the normal `202 Accepted` code - an error is not thrown, however repeat requests will be counted against any rate limit that is in place.

### HTTP API Responses

- Successful responses to submitted events return `202 Accepted` with an empty body.
- Unauthorised access will be rejected with a `401 Unauthorized` or `403 Forbidden` response code.
- Events sent about users that cannot be found will return a `404 Not Found`.
- Event lists containing duplicate events will have those duplicates ignored.
- Server errors will return a `500` response code and may contain an error message in the body.



Submit a data event

Create event summaries for a user. Event summaries are used to track the number of times an event has occurred, the first time it occurred and the last time it occurred.



Create event summaries

You can view the status of your job by sending a `GET` request to the URL
`https://api.intercom.io/export/content/data/{job_identifier}` - the `{job_identifier}` is the value returned in the response when you first created the export job. More on it can be seen in the Export Job Model.

> 🚧 Jobs expire after two days
> All jobs that have completed processing (and are thus available to download from the provided URL) will have an expiry limit of two days from when the export ob completed. After this, the data will no longer be available.


Show content data export

When a job has a status of complete, and thus a filled download_url, you can download your data by hitting that provided URL, formatted like so: https://api.intercom.io/download/content/data/xyz1234.

Your exported message data will be streamed continuously back down to you in a gzipped CSV format.

> 📘 Octet header required
>
> You will have to specify the header Accept: `application/octet-stream` when hitting this endpoint.


Download content data export

To create your export job, you need to send a `POST` request to the export endpoint `https://api.intercom.io/export/content/data`.

The only parameters you need to provide are the range of dates that you want exported.

>🚧 Limit of one active job
>
> You can only have one active job per workspace. You will receive a HTTP status code of 429 with the message Exceeded rate limit of 1 pending message data export jobs if you attempt to create a second concurrent job.

>❗️ Updated_at not included
>
> It should be noted that the timeframe only includes messages sent during the time period and not messages that were only updated during this period. For example, if a message was updated yesterday but sent two days ago, you would need to set the created_at_after date before the message was sent to include that in your retrieval job.

>📘 Date ranges are inclusive
>
> Requesting data for 2018-06-01 until 2018-06-30 will get all data for those days including those specified - e.g. 2018-06-01 00:00:00 until 2018-06-30 23:59:99.


Create content data export

Cancel content data export

You can fetch a list of all collections by making a GET request to `https://api.intercom.io/help_center/collections`.

> 📘 How are the collections sorted and ordered?
>
> Collections will be returned in descending order on the `updated_at` attribute. This means if you need to iterate through results then we'll show the most recently updated collections first.


List all collections

You can create a new collection by making a POST request to `https://api.intercom.io/help_center/collections.`

Create a collection

You can fetch the details of a single collection by making a GET request to `https://api.intercom.io/help_center/collections/<id>`.

Retrieve a collection

You can update the details of a single collection by making a PUT request to `https://api.intercom.io/collections/<id>`.

Update a collection

You can delete a single collection by making a DELETE request to `https://api.intercom.io/collections/<id>`.

Delete a collection

You can fetch a list of all sections by making a GET request to `https://api.intercom.io/help_center/sections`.
> 📘 How are the sections sorted and ordered?
>
> Sections will be returned in descending order on the `updated_at` attribute. This means if you need to iterate through results then we'll show the most recently updated sections first.


List all sections

You can create a new section by making a POST request to `https://api.intercom.io/help_center/sections.`

Create a section

You can fetch the details of a single section by making a GET request to `https://api.intercom.io/help_center/sections/<id>`.

Retrieve a section

You can update the details of a single section by making a PUT request to `https://api.intercom.io/sections/<id>`.

Update a section

You can delete a single section by making a DELETE request to `https://api.intercom.io/sections/<id>`.

Delete a section

You can create a message that has been initiated by an admin. The conversation can be either an in-app message or an email.

> 🚧 Sending for visitors
>
> There can be a short delay between when a contact is created and when a contact becomes available to be messaged through the API. A 404 Not Found error will be returned in this case.

This will return the Message model that has been created.

> 🚧 Retrieving Associated Conversations
>
> As this is a message, there will be no conversation present until the contact responds. Once they do, you will have to search for a contact's conversations with the id of the message.


Create a message

List all news items

Create a news item

You can fetch the details of a single news item.

Retrieve a news item

Update a news item

Delete a news item

You can fetch a list of all news items that are live on a given newsfeed

List all live newsfeed items

List all newsfeeds

You can fetch the details of a single newsfeed

Retrieve a newsfeed

You can fetch a list of notes that are associated to a contact.

List all notes

Create a note

You can fetch the details of a single note.

Retrieve a note

List all segments

You can fetch the details of a single segment.

Retrieve a segment

You can list all subscription types. A list of subscription type objects will be returned.

List subscription types

You can remove a specific subscription from a contact. This will return a subscription type model for the subscription type that was removed from the contact.

Remove subscription from a contact

You can use the API to deflect phone calls to the Intercom Messenger.
Calling this endpoint will send an SMS with a link to the Messenger to the phone number specified.

If custom attributes are specified, they will be added to the user or lead's custom data attributes.


Create a phone Switch

You can fetch a list of all tags for a given workspace.



List all tags

You can use this endpoint to perform the following operations:

  **1. Create a new tag:** You can create a new tag by passing in the tag name as specified in "Create or Update Tag Request Payload" described below.

  **2. Update an existing tag:** You can update an existing tag by passing the id of the tag as specified in "Create or Update Tag Request Payload" described below.

  **3. Tag Companies:** You can tag single company or a list of companies. You can tag a company by passing in the tag name and the company details as specified in "Tag Company Request Payload" described below. Also, if the tag doesn't exist then a new one will be created automatically.

  **4. Untag Companies:** You can untag a single company or a list of companies. You can untag a company by passing in the tag id and the company details as specified in "Untag Company Request Payload" described below.

  **5. Tag Multiple Users:** You can tag a list of users. You can tag the users by passing in the tag name and the user details as specified in "Tag Users Request Payload" described below.

Each operation will return a tag object.


Create or update a tag, Tag or untag companies, Tag contacts

You can fetch the details of tags that are on the workspace by their id.
This will return a tag object.


Find a specific tag

You can delete the details of tags that are on the workspace by passing in the id.

Delete tag

You can tag a specific conversation. This will return a tag object for the tag that was added to the conversation.

Add tag to a conversation

You can remove tag from a specific contact. This will return a tag object for the tag that was removed from the contact.

Remove tag from a contact

You can remove tag from a specific conversation. This will return a tag object for the tag that was removed from the conversation.

Remove tag from a conversation

This will return a list of team objects for the App.

List all teams

You can fetch the details of a single team, containing an array of admins that belong to this team.

Retrieve a team

You can fetch the details of a single visitor.

Retrieve a visitor with User ID

Sending a PUT request to `/visitors` will result in an update of an existing Visitor.

**Option 1.** You can update a visitor by passing in the `user_id` of the visitor in the Request body.

**Option 2.** You can update a visitor by passing in the `id` of the visitor in the Request body.


Update a visitor

Retrieve a visitor with ID

Delete a visitor

You can merge a Visitor to a Contact of role type `lead` or `user`.

> 📘 What happens upon a visitor being converted?
>
> If the User exists, then the Visitor will be merged into it, the Visitor deleted and the User returned. If the User does not exist, the Visitor will be converted to a User, with the User identifiers replacing it's Visitor identifiers.


Convert a visitor

Salesforce

HubSpot

# Realtime Full two-way Sync of Companies

This scenario enables your application to fully sync Companies between your app and any external application in both directions. It handles the initial import/export of Companies and then sends events when a Company is created, updated, or deleted on any side, as close to real-time as possible.

Company fields will be mapped from your application's schema to the application-specific schema.

## How It Works

1. **Initial Sync**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page. Integration.app transforms the output into a consistent format compatible with your API, allowing you to save and match data efficiently.
   - Make another set of requests to create Companies in external app, if needed.

2. **Continuous Sync from External App**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events from external applications.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.


2. **Continuous Sync from Your App**:
   - You will get a single webhook URI that you will use to send events about created, updated, or deleted Companies to Integration.app.
   - Once send, Integration.app will map the webhook payload to the format supported by external application and send the correct request


Two-way realtime sync of Companies

Bi-directional realtime sync of Companies with records deduplication

Intercom API Integration Profile

Supercharge your product integrations today