# Intercom API API

> Intercom API API on Apizie: 108 endpoints (Identify an admin, Set an admin to away, List all activity logs, List all admins, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://apizie.tech/v1/business:intercom/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `business:intercom`
- Category: Business
- Status: byok
- Source: https://developers.intercom.com
- Page: https://apizie.tech/api/business/intercom
- OpenAPI: https://apizie.tech/api/business/intercom/openapi.json

The intercom API reference.

## Endpoints

### Identify an admin
`GET https://apizie.tech/v1/business:intercom/identify-admin` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |

### Set an admin to away
`POST https://apizie.tech/v1/business:intercom/set-away-admin` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| admin_id | string | yes | The unique identifier of a given admin |
| body | object | no | JSON request body |

### List all activity logs
`GET https://apizie.tech/v1/business:intercom/list-activity-logs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| created_at_after | string | yes | The start date that you request data for. It must be formatted as a UNIX timestamp. |
| created_at_before | string | no | The end date that you request data for. It must be formatted as a UNIX timestamp. |

### List all admins
`GET https://apizie.tech/v1/business:intercom/list-admins` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| display_avatar | boolean | no | If set to true, the response will include the admin's avatar object containing the image URL. Defaults to false. |

### Retrieve an admin
`GET https://apizie.tech/v1/business:intercom/retrieve-admin` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| admin_id | string | yes | The unique identifier of a given admin |

### List all articles
`GET https://apizie.tech/v1/business:intercom/list-articles` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| page | integer | no | The page of results to fetch. Defaults to first page |
| per_page | integer | no | How many results to display per page. Defaults to 15 |

### Create an article
`POST https://apizie.tech/v1/business:intercom/create-article` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| body | object | no | JSON request body |

### Retrieve an article
`GET https://apizie.tech/v1/business:intercom/retrieve-article` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| article_id | string | yes | The unique identifier for the article which is given by Intercom. |

### Update an article
`POST https://apizie.tech/v1/business:intercom/update-article` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| article_id | string | yes | The unique identifier for the article which is given by Intercom. |
| body | object | no | JSON request body |

### Delete an article
`POST https://apizie.tech/v1/business:intercom/delete-article` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| article_id | string | yes | The unique identifier for the article which is given by Intercom. |

### Search for articles
`GET https://apizie.tech/v1/business:intercom/search-articles` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| phrase | string | no | The phrase within your articles to search for. |
| state | string | no | The state of the Articles returned. One of `published`, `draft` or `all`. |
| help_center_id | integer | no | The ID of the Help Center to search in. |
| highlight | boolean | no | Return a highlighted version of the matching content within your articles. Refer to the response schema for more details. |

### List all collections
`GET https://apizie.tech/v1/business:intercom/list-all-collections` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| page | integer | no | The page of results to fetch. Defaults to first page |
| per_page | integer | no | How many results to display per page. Defaults to 15 |

### Create a collection
`POST https://apizie.tech/v1/business:intercom/create-collection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| body | object | no | JSON request body |

### Retrieve a collection
`GET https://apizie.tech/v1/business:intercom/retrieve-collection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| collection_id | string | yes | The unique identifier for the collection which is given by Intercom. |

### Update a collection
`POST https://apizie.tech/v1/business:intercom/update-collection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| collection_id | string | yes | The unique identifier for the collection which is given by Intercom. |
| body | object | no | JSON request body |

### Delete a collection
`POST https://apizie.tech/v1/business:intercom/delete-collection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| collection_id | string | yes | The unique identifier for the collection which is given by Intercom. |

### Retrieve a Help Center
`GET https://apizie.tech/v1/business:intercom/retrieve-help-center` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| help_center_id | string | yes | The unique identifier for the Help Center which is given by Intercom. |

### List all Help Centers
`GET https://apizie.tech/v1/business:intercom/list-help-centers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| page | integer | no | The page of results to fetch. Defaults to first page |
| per_page | integer | no | How many results to display per page. Defaults to 15 |

### Retrieve companies
`GET https://apizie.tech/v1/business:intercom/retrieve-company` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| name | string | no | The `name` of the company to filter by. |
| company_id | string | no | The `company_id` of the company to filter by. |
| tag_id | string | no | The `tag_id` of the company to filter by. |
| segment_id | string | no | The `segment_id` of the company to filter by. |
| page | integer | no | The page of results to fetch. Defaults to first page |
| per_page | integer | no | How many results to display per page. Defaults to 15 |

### Create or Update a company
`POST https://apizie.tech/v1/business:intercom/create-or-update-company` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| body | object | no | JSON request body |

### Retrieve a company by ID
`GET https://apizie.tech/v1/business:intercom/retrieve-acompany-by-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| company_id | string | yes | The unique identifier for the company which is given by Intercom |

### Update a company
`POST https://apizie.tech/v1/business:intercom/update-company` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| company_id | string | yes | The unique identifier for the company which is given by Intercom |

### Delete a company
`POST https://apizie.tech/v1/business:intercom/delete-company` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| company_id | string | yes | The unique identifier for the company which is given by Intercom |

### List attached contacts
`GET https://apizie.tech/v1/business:intercom/list-attached-contacts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| company_id | string | yes | The unique identifier for the company which is given by Intercom |
| page | integer | no | The page of results to fetch. Defaults to first page |
| per_page | integer | no | How many results to return per page. Defaults to 15 |

### List attached segments for companies
`GET https://apizie.tech/v1/business:intercom/list-attached-segments-for-companies` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| company_id | string | yes | The unique identifier for the company which is given by Intercom |

### List all companies
`POST https://apizie.tech/v1/business:intercom/list-all-companies` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| page | integer | no | The page of results to fetch. Defaults to first page |
| per_page | integer | no | How many results to return per page. Defaults to 15 |
| order | string | no | `asc` or `desc`. Return the companies in ascending or descending order. Defaults to desc |

### Scroll over all companies
`GET https://apizie.tech/v1/business:intercom/scroll-over-all-companies` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| scroll_param | string | no |  |

### List attached companies for contact
`GET https://apizie.tech/v1/business:intercom/list-companies-for-acontact` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| contact_id | string | yes | The unique identifier for the contact which is given by Intercom |
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| page | integer | no | The page of results to fetch. Defaults to first page |
| per_page | integer | no | How many results to display per page. Defaults to 15 |

### Attach a Contact to a Company
`POST https://apizie.tech/v1/business:intercom/attach-contact-to-acompany` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| contact_id | string | yes | The unique identifier for the contact which is given by Intercom |
| body | object | no | JSON request body |

### Detach a contact from a company
`POST https://apizie.tech/v1/business:intercom/detach-contact-from-acompany` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| contact_id | string | yes | The unique identifier for the contact which is given by Intercom |
| company_id | string | yes | The unique identifier for the company which is given by Intercom |

### List all notes
`GET https://apizie.tech/v1/business:intercom/list-notes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| contact_id | string | yes | The unique identifier of a contact. |
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| page | integer | no | The page of results to fetch. Defaults to first page |
| per_page | integer | no | How many results to display per page. Defaults to 15 |

### Create a note
`POST https://apizie.tech/v1/business:intercom/create-note` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| contact_id | string | yes | The unique identifier of a given contact. |
| body | object | no | JSON request body |

### List attached segments for contact
`GET https://apizie.tech/v1/business:intercom/list-segments-for-acontact` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| contact_id | string | yes | The unique identifier for the contact which is given by Intercom |
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |

### List subscriptions for a contact
`GET https://apizie.tech/v1/business:intercom/list-subscriptions-for-acontact` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| contact_id | string | yes | The unique identifier for the contact which is given by Intercom |
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |

### Add subscription to a contact
`POST https://apizie.tech/v1/business:intercom/attach-subscription-type-to-contact` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| contact_id | string | yes | The unique identifier for the contact which is given by Intercom |
| body | object | no | JSON request body |

### Remove subscription from a contact
`POST https://apizie.tech/v1/business:intercom/detach-subscription-type-to-contact` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| contact_id | string | yes | The unique identifier for the contact which is given by Intercom |
| subscription_id | string | yes | The unique identifier for the subscription type which is given by Intercom |

### List tags attached to a contact
`GET https://apizie.tech/v1/business:intercom/list-tags-for-acontact` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| contact_id | string | yes | The unique identifier for the contact which is given by Intercom |

### Add tag to a contact
`POST https://apizie.tech/v1/business:intercom/attach-tag-to-contact` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| contact_id | string | yes | The unique identifier for the contact which is given by Intercom |
| body | object | no | JSON request body |

### Remove tag from a contact
`POST https://apizie.tech/v1/business:intercom/detach-tag-from-contact` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| contact_id | string | yes | The unique identifier for the contact which is given by Intercom |
| tag_id | string | yes | The unique identifier for the tag which is given by Intercom |

### Get a contact
`GET https://apizie.tech/v1/business:intercom/show-contact` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| contact_id | string | yes | id |

### Update a contact
`POST https://apizie.tech/v1/business:intercom/update-contact` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| contact_id | string | yes | id |
| body | object | no | JSON request body |

### Delete a contact
`POST https://apizie.tech/v1/business:intercom/delete-contact` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| contact_id | string | yes | id |

### Merge a lead and a user
`POST https://apizie.tech/v1/business:intercom/merge-contact` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| body | object | no | JSON request body |

### Search contacts
`POST https://apizie.tech/v1/business:intercom/search-contacts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| body | object | no | JSON request body |

### List all contacts
`GET https://apizie.tech/v1/business:intercom/list-contacts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| page | integer | no | The page of results to fetch. Defaults to first page |
| per_page | integer | no | How many results to display per page. Defaults to 15 |
| starting_after | string | no | String used to get the next page of conversations. |

### Create contact
`POST https://apizie.tech/v1/business:intercom/create-contact` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| body | object | no | JSON request body |

### Archive contact
`POST https://apizie.tech/v1/business:intercom/archive-contact` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| contact_id | string | yes | id |

### Unarchive contact
`POST https://apizie.tech/v1/business:intercom/unarchive-contact` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| contact_id | string | yes | id |

### Add tag to a conversation
`POST https://apizie.tech/v1/business:intercom/attach-tag-to-conversation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| conversation_id | string | yes | conversation_id |
| body | object | no | JSON request body |

### Remove tag from a conversation
`POST https://apizie.tech/v1/business:intercom/detach-tag-from-conversation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| conversation_id | string | yes | conversation_id |
| tag_id | string | yes | id |
| body | object | no | JSON request body |

### List all conversations
`GET https://apizie.tech/v1/business:intercom/list-conversations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| per_page | integer | no | How many results per page |
| starting_after | string | no | String used to get the next page of conversations. |

### Creates a conversation
`POST https://apizie.tech/v1/business:intercom/create-conversation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| body | object | no | JSON request body |

### Retrieve a conversation
`GET https://apizie.tech/v1/business:intercom/retrieve-conversation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| conversation_id | string | yes | The id of the conversation to target |
| display_as | string | no | Set to plaintext to retrieve conversation messages in plain text. |

### Update a conversation
`POST https://apizie.tech/v1/business:intercom/update-conversation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| conversation_id | string | yes | The id of the conversation to target |
| display_as | string | no | Set to plaintext to retrieve conversation messages in plain text. |
| body | object | no | JSON request body |

### Search conversations
`POST https://apizie.tech/v1/business:intercom/search-conversations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| body | object | no | JSON request body |

### Reply to a conversation
`POST https://apizie.tech/v1/business:intercom/reply-conversation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| conversation_id | string | yes | The Intercom provisioned identifier for the conversation or the string "last" to reply to the last part of the conversation |
| body | object | no | JSON request body |

### Manage a conversation
`POST https://apizie.tech/v1/business:intercom/manage-conversation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| conversation_id | string | yes | The identifier for the conversation as given by Intercom. |
| body | object | no | JSON request body |

### Run Assignment Rules on a conversation
`POST https://apizie.tech/v1/business:intercom/auto-assign-conversation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| conversation_id | string | yes | The identifier for the conversation as given by Intercom. |

### Attach a contact to a conversation
`POST https://apizie.tech/v1/business:intercom/attach-contact-to-conversation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| conversation_id | string | yes | The identifier for the conversation as given by Intercom. |
| body | object | no | JSON request body |

### Detach a contact from a group conversation
`POST https://apizie.tech/v1/business:intercom/detach-contact-from-conversation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| conversation_id | string | yes | The identifier for the conversation as given by Intercom. |
| contact_id | string | yes | The identifier for the contact as given by Intercom. |
| body | object | no | JSON request body |

### Redact a conversation part
`POST https://apizie.tech/v1/business:intercom/redact-conversation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| body | object | no | JSON request body |

### Convert a conversation to a ticket
`POST https://apizie.tech/v1/business:intercom/convert-conversation-to-ticket` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| conversation_id | string | yes | The id of the conversation to target |
| body | object | no | JSON request body |

### List all data attributes
`GET https://apizie.tech/v1/business:intercom/list-data-attributes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| model | string | no | Specify the data attribute model to return. |
| include_archived | boolean | no | Include archived attributes in the list. By default we return only non archived data attributes. |

### Create a data attribute
`POST https://apizie.tech/v1/business:intercom/create-data-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| body | object | no | JSON request body |

### Update a data attribute
`POST https://apizie.tech/v1/business:intercom/update-data-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| data_attribute_id | string | yes | The data attribute id |
| body | object | no | JSON request body |

### List all data events
`GET https://apizie.tech/v1/business:intercom/lis-data-events` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| filter | object | yes |  |
| type | string | yes | The value must be user |
| summary | boolean | no | summary flag |
| per_page | integer | no | How many results to display per page. Defaults to 15 |

### Submit a data event
`POST https://apizie.tech/v1/business:intercom/create-data-event` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| body | object | no | JSON request body |

### Create event summaries
`POST https://apizie.tech/v1/business:intercom/data-event-summaries` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| body | object | no | JSON request body |

### Create content data export
`POST https://apizie.tech/v1/business:intercom/create-data-export` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| body | object | no | JSON request body |

### Show content data export
`GET https://apizie.tech/v1/business:intercom/get-data-export` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| job_identifier | string | yes | job_identifier |

### Cancel content data export
`POST https://apizie.tech/v1/business:intercom/cancel-data-export` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| job_identifier | string | yes | job_identifier |

### Download content data export
`GET https://apizie.tech/v1/business:intercom/download-data-export` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| job_identifier | string | yes | job_identifier |

### Create a message
`POST https://apizie.tech/v1/business:intercom/create-message` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| body | object | no | JSON request body |

### List all news items
`GET https://apizie.tech/v1/business:intercom/list-news-items` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |

### Create a news item
`POST https://apizie.tech/v1/business:intercom/create-news-item` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| body | object | no | JSON request body |

### Retrieve a news item
`GET https://apizie.tech/v1/business:intercom/retrieve-news-item` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| news_item_id | string | yes | The unique identifier for the news item which is given by Intercom. |

### Update a news item
`POST https://apizie.tech/v1/business:intercom/update-news-item` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| news_item_id | string | yes | The unique identifier for the news item which is given by Intercom. |
| body | object | no | JSON request body |

### Delete a news item
`POST https://apizie.tech/v1/business:intercom/delete-news-item` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| news_item_id | string | yes | The unique identifier for the news item which is given by Intercom. |

### List all live newsfeed items
`GET https://apizie.tech/v1/business:intercom/list-live-newsfeed-items` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| newsfeed_id | string | yes | The unique identifier for the news feed item which is given by Intercom. |

### List all newsfeeds
`GET https://apizie.tech/v1/business:intercom/list-newsfeeds` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |

### Retrieve a newsfeed
`GET https://apizie.tech/v1/business:intercom/retrieve-newsfeed` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| newsfeed_id | string | yes | The unique identifier for the news feed item which is given by Intercom. |

### Retrieve a note
`GET https://apizie.tech/v1/business:intercom/retrieve-note` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| note_id | string | yes | The unique identifier of a given note |

### List all segments
`GET https://apizie.tech/v1/business:intercom/list-segments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| include_count | boolean | no | It includes the count of contacts that belong to each segment. |

### Retrieve a segment
`GET https://apizie.tech/v1/business:intercom/retrieve-segment` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| segment_id | string | yes | The unique identified of a given segment. |

### List subscription types
`GET https://apizie.tech/v1/business:intercom/list-subscription-types` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |

### Create a phone Switch
`POST https://apizie.tech/v1/business:intercom/create-phone-switch` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| body | object | no | JSON request body |

### List all tags
`GET https://apizie.tech/v1/business:intercom/list-tags` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |

### Create or update a tag, Tag or untag companies, Tag contacts
`POST https://apizie.tech/v1/business:intercom/create-tag` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| body | object | no | JSON request body |

### Find a specific tag
`GET https://apizie.tech/v1/business:intercom/find-tag` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| tag_id | string | yes | The unique identifier of a given tag |

### Delete tag
`POST https://apizie.tech/v1/business:intercom/delete-tag` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| tag_id | string | yes | The unique identifier of a given tag |

### List all teams
`GET https://apizie.tech/v1/business:intercom/list-teams` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |

### Retrieve a team
`GET https://apizie.tech/v1/business:intercom/retrieve-team` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| team_id | string | yes | The unique identifier of a given team. |

### Create a new attribute for a ticket type
`POST https://apizie.tech/v1/business:intercom/create-ticket-type-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| ticket_type_id | string | yes | The unique identifier for the ticket type which is given by Intercom. |
| body | object | no | JSON request body |

### Update an existing attribute for a ticket type
`POST https://apizie.tech/v1/business:intercom/update-ticket-type-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| ticket_type_id | string | yes | The unique identifier for the ticket type which is given by Intercom. |
| attribute_id | string | yes | The unique identifier for the ticket type attribute which is given by Intercom. |
| body | object | no | JSON request body |

### List all ticket types
`GET https://apizie.tech/v1/business:intercom/list-ticket-types` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |

### Create a ticket type
`POST https://apizie.tech/v1/business:intercom/create-ticket-type` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| body | object | no | JSON request body |

### Retrieve a ticket type
`GET https://apizie.tech/v1/business:intercom/get-ticket-type` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| ticket_type_id | string | yes | The unique identifier for the ticket type which is given by Intercom. |

### Update a ticket type
`POST https://apizie.tech/v1/business:intercom/update-ticket-type` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| ticket_type_id | string | yes | The unique identifier for the ticket type which is given by Intercom. |
| body | object | no | JSON request body |

### Reply to a ticket
`POST https://apizie.tech/v1/business:intercom/reply-ticket` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| ticket_id | string | yes | The id of the ticket to target. |
| body | object | no | JSON request body |

### Add tag to a ticket
`POST https://apizie.tech/v1/business:intercom/attach-tag-to-ticket` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| ticket_id | string | yes | ticket_id |
| body | object | no | JSON request body |

### Remove tag from a ticket
`POST https://apizie.tech/v1/business:intercom/detach-tag-from-ticket` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| ticket_id | string | yes | ticket_id |
| tag_id | string | yes | The unique identifier for the tag which is given by Intercom |
| body | object | no | JSON request body |

### Create a ticket
`POST https://apizie.tech/v1/business:intercom/create-ticket` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| body | object | no | JSON request body |

### Retrieve a ticket
`GET https://apizie.tech/v1/business:intercom/get-ticket` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| ticket_id | string | yes | The unique identifier for the ticket which is given by Intercom. |

### Update a ticket
`POST https://apizie.tech/v1/business:intercom/update-ticket` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| ticket_id | string | yes | The unique identifier for the ticket which is given by Intercom |
| body | object | no | JSON request body |

### Search tickets
`POST https://apizie.tech/v1/business:intercom/search-tickets` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| body | object | no | JSON request body |

### Retrieve a visitor with User ID
`GET https://apizie.tech/v1/business:intercom/retrieve-visitor-with-user-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| user_id | string | yes | The user_id of the Visitor you want to retrieve. |

### Update a visitor
`POST https://apizie.tech/v1/business:intercom/update-visitor` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| body | object | no | JSON request body |

### Convert a visitor
`POST https://apizie.tech/v1/business:intercom/convert-visitor` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| Intercom-Version | string | no | Intercom API version. By default, it's equal to the version set in the app package. |
| body | object | no | JSON request body |

## Example
```
curl "https://apizie.tech/v1/business:intercom/identify-admin" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Intercom API API?
Create a free Apizie key, then send GET https://apizie.tech/v1/business:intercom/identify-admin with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Intercom API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Intercom API itself also needs your own key from intercom.

### Can AI agents use the Intercom API API?
Yes. Add the Apizie MCP server (https://apizie.tech/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key business:intercom.

### What is the status of the Intercom API API?
Needs your own provider key (bring your own key)