Articles in this section

Available Intercom APIs

When you configure an export, import, or other type of flow step using the prebuilt Intercom connector, you can select any of the API operations listed below, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the Intercom API documentation. You can also create a composite endpoint for this application in HTTP mode.

Resource API endpoint Export Import
Contacts List all contacts X
Retrieve a contact X
List attached companies X
List attached segments X
Search for contacts X
List attached tags X
Create a contact X
Update a contact X
Delete a contact X
Archive a contact X
Unarchive a contact X
Merge two contacts X
Data attributes List all data attributes X
Companies List all companies X
Retrieve a company X
List attached contacts X
List attached segments X
Scroll over all companies X
Create or update company X
Delete a company X
Attach a contact X
Detach a contact X
Admins List admins X
View an admin X
Identify an admin X
List all activity logs X
Set an admin to away X
Teams List all teams X
Retrieve a team X
Tags List all tags X
Create and update tags X
Tag companies X
Untag companies X
Delete a tag X
Detach a contact X
Detach a conversation X
Attach a contact X
Attach a conversation X
Segments List all segments X
Retrieve a segment X
Notes List all notes X
Retrieve a note X
Create a note X
Data events List events X
Submit a data event X
Counts App total count model X
Conversation count model X
Admin conversations count model X
User segment/tag count model X
Segment/tag count model X
Get company user X
Conversations List all conversations X
Retrieve a conversation X
Search for conversations X
Create a conversation X
Update a conversation X
Replying to a conversation X
Replying to users last conversation X
Assign a conversation X
Run assignment rules on a conversation X
Snoozing a conversation X
Open a conversation X
Close a conversation X
Attach a contact X
Detach a contact X
Redact a conversation part X
Articles List all articles X
Retrieve an article X
Create an article X
Update an article X
Delete an article X
Help center List all sections X
Retrieve a section X
List all collections X
Retrieve a collection X
Create a collection X
Update a collection X
Delete a collection X
Create a section X
Update a section X
Delete a section X

Available DI objects

The following objects are available when using Intercom as a source in Celigo Data Integration (DI).

Primary key: All Intercom DI endpoints use a top-level string id as the primary key. Intercom assigns a unique id to every object it returns, so id is the consistent key across resources.

Note

Intercom soft deletes records. A standard delete archives the record to a recycle-bin state where it stays restorable, and permanent removal only happens through the separate GDPR/permanent-delete path. Celigo syncs all data returned by the source as-is.

Object API endpoint Available extract modes Delta field
Admins List admins Full —
Articles List all articles Full —
Companies List all companies Full —
Contacts List all contacts Full —
Conversations List all conversations Full —
Help center List all sections Full —
Segments List all segments Full —
Tags List all tags Full —
Teams List all teams Full —

Response schemas

Click an object below to view its response fields and delta configuration.

Admins — List admins

Response schema:

Field Type
away_mode_enabled boolean
away_mode_reassign boolean
email string
has_inbox_seat boolean
id number (Primary key)
name string
team_ids object
team_priority_level object
type string
Articles — List all articles

Response schema:

Field Type
type string
id string (Primary key)
workspace_id string
title string
description string
body string
author_id number
state string
created_at number
updated_at number
url string
parent_id number
parent_type string
parent_ids numberarray
default_locale string
statistics object
statistics.type string
statistics.views number
statistics.conversations number
statistics.reactions number
statistics.happy_reaction_percentage number
statistics.neutral_reaction_percentage number
statistics.sad_reaction_percentage number
translated_content object
Companies — List all companies

Response schema:

Field Type
app_id string
company_id string
created_at number
custom_attributes object
id string (Primary key)
monthly_spend number
name string
plan object
segments object
segments.type string
segments.segments object
session_count number
tags object
tags.type string
tags.tags object
type string
updated_at number
user_count number
Contacts — List all contacts

Response schema:

Field Type
android_app_name string
android_app_version string
android_device string
android_last_seen_at string
android_os_version string
android_sdk_version string
avatar string
browser string
browser_language string
browser_version string
companies object
companies.url string
companies.data objectarray
companies.data.id string
companies.data.url string
companies.data.type string
companies.has_more boolean
companies.total_count number
companies.type string
created_at number
custom_attributes object
email string
external_id string
has_hard_bounced boolean
id string (Primary key)
ios_app_name string
ios_app_version string
ios_device string
ios_last_seen_at string
ios_os_version string
ios_sdk_version string
language_override string
last_contacted_at string
last_email_clicked_at string
last_email_opened_at string
last_replied_at string
last_seen_at number
location object
location.region string
location.country string
location.type string
location.city string
marked_email_as_spam boolean
name string
notes object
notes.url string
notes.total_count number
notes.type string
notes.has_more boolean
notes.data object
opted_out_subscription_types object
opted_out_subscription_types.url string
opted_out_subscription_types.total_count number
opted_out_subscription_types.type string
opted_out_subscription_types.has_more boolean
opted_out_subscription_types.data object
os string
owner_id string
phone string
role string
signed_up_at number
sms_consent boolean
social_profiles object
social_profiles.type string
social_profiles.data object
tags object
tags.url string
tags.total_count number
tags.type string
tags.has_more boolean
tags.data object
type string
unsubscribed_from_emails boolean
unsubscribed_from_sms boolean
updated_at number
workspace_id string
Conversations — List all conversations

Response schema:

Field Type
admin_assignee_id string
contacts object
contacts.contacts objectarray
contacts.contacts.id string
contacts.contacts.type string
contacts.type string
conversation_rating string
created_at number
custom_attributes object
first_contact_reply string
id number (Primary key)
open boolean
priority string
read boolean
sla_applied string
snoozed_until string
source string
state string
statistics object
statistics.count_reopens number
statistics.count_conversation_parts number
statistics.count_assignments number
statistics.type string
statistics.time_to_admin_reply string
statistics.last_contact_reply_at string
statistics.last_close_at string
statistics.first_close_at string
statistics.time_to_last_close string
statistics.first_assignment_at string
statistics.median_time_to_reply string
statistics.time_to_assignment string
statistics.first_admin_reply_at string
statistics.time_to_first_close string
statistics.last_assignment_admin_reply_at string
statistics.last_assignment_at string
statistics.last_closed_by_id string
statistics.first_contact_reply_at string
statistics.last_admin_reply_at string
tags object
tags.type string
tags.tags object
team_assignee_id string
teammates object
teammates.type string
teammates.admins object
title string
topics object
topics.total_count number
topics.type string
topics.topics object
type string
updated_at number
waiting_since string
Help center — List all sections

Response schema:

Field Type
type string
id string (Primary key)
workspace_id string
name string
url string
order number
created_at number
updated_at number
parent_id number
collection_id string
translated_content object
Segments — List all segments

Response schema:

Field Type
type string
id string (Primary key)
name string
created_at number
updated_at number
person_type string
count number
Tags — List all tags

Response schema:

Field Type
type string
id string (Primary key)
name string
Teams — List all teams

Response schema:

Field Type
type string
id string (Primary key)
name string
admin_ids numberarray
admin_priority_level object
admin_priority_level.primary_admin_ids numberarray
admin_priority_level.secondary_admin_ids numberarray