← Tools Reference

Intercom

Intercom integration (Communication, Productivity). Imported from open-connector.

OAuth18 toolshttps://api.intercom.io
GET
intercom_get_current_admin
Get the currently authorized Intercom admin and workspace metadata.

/me

GET
intercom_list_admins
List Intercom admins for the current workspace.

/admins

1 parameter
ParamTypeRequiredDescription
displayAvatarbooleanoptionalWhether Intercom should include admin avatar objects in the response.
GET
intercom_get_admin
Get a single Intercom admin by identifier.

/admins/{adminId}

1 parameter
ParamTypeRequiredDescription
adminIdstringrequiredIntercom admin identifier.
GET
intercom_list_contacts
List Intercom contacts with cursor-based pagination.

/contacts

2 parameters
ParamTypeRequiredDescription
perPageintegeroptionalMaximum number of Intercom records to return.
startingAfterstringoptionalOpaque Intercom cursor returned from a previous paginated response.
POST
intercom_search_contacts
Search Intercom contacts with the official search DSL.

/contacts/search

3 parameters
ParamTypeRequiredDescription
queryobjectrequiredIntercom key-value object.
perPageintegeroptionalMaximum number of Intercom records to return.
startingAfterstringoptionalOpaque Intercom cursor returned from a previous paginated response.
GET
intercom_get_contact
Get a single Intercom contact by identifier.

/contacts/{contactId}

1 parameter
ParamTypeRequiredDescription
contactIdstringrequiredIntercom contact identifier.
GET
intercom_get_contact_by_external_id
Get a single Intercom contact by external ID.

/contacts/find_by_external_id/{externalId}

1 parameter
ParamTypeRequiredDescription
externalIdstringrequiredExternal identifier stored on the Intercom contact.
GET
intercom_get_company
Get a single Intercom company by company ID or name.

/companies

2 parameters
ParamTypeRequiredDescription
companyIdstringoptionalCompany identifier defined by you in Intercom.
namestringoptionalCompany name to look up in Intercom.
GET
intercom_list_conversations
List Intercom conversations with cursor-based pagination.

/conversations

2 parameters
ParamTypeRequiredDescription
perPageintegeroptionalMaximum number of Intercom records to return.
startingAfterstringoptionalOpaque Intercom cursor returned from a previous paginated response.
GET
intercom_get_conversation
Get a single Intercom conversation with its conversation parts.

/conversations/{conversationId}

2 parameters
ParamTypeRequiredDescription
conversationIdstringrequiredIntercom conversation identifier.
displayAsstringoptionalHow Intercom should render conversation message bodies in the response.
GET
intercom_list_events
List recent Intercom data events for one user or lead.

/events

5 parameters
ParamTypeRequiredDescription
userIdstringoptionalUser ID used to identify the Intercom user.
emailstringoptionalEmail address used to identify the Intercom user.
intercomUserIdstringoptionalIntercom user or lead identifier.
summarybooleanoptionalWhether Intercom should return event summary data.
perPageintegeroptionalMaximum number of Intercom records to return.
GET
intercom_list_tags
List all Intercom tags for the current workspace.

/tags

GET
intercom_get_counts
Read Intercom workspace, conversation, or grouped counts.

/counts

2 parameters
ParamTypeRequiredDescription
typestringoptionalIntercom count type to request, such as conversation.
countstringoptionalIntercom count grouping to request, such as tag or segment.
GET
intercom_get_ticket
Get a single Intercom ticket by internal ticket identifier.

/tickets/{ticketId}

1 parameter
ParamTypeRequiredDescription
ticketIdstringrequiredInternal Intercom ticket identifier.
POST
intercom_search_tickets
Search Intercom tickets with the official search DSL.

/tickets/search

3 parameters
ParamTypeRequiredDescription
queryobjectrequiredIntercom key-value object.
perPageintegeroptionalMaximum number of Intercom records to return.
startingAfterstringoptionalOpaque Intercom cursor returned from a previous paginated response.
GET
intercom_get_job_status
Get the status of an Intercom asynchronous job.

/jobs/status/{jobId}

1 parameter
ParamTypeRequiredDescription
jobIdstringrequiredIntercom job identifier.
GET
intercom_list_articles
List Intercom help center articles.

/articles

2 parameters
ParamTypeRequiredDescription
perPageintegeroptionalMaximum number of Intercom records to return.
startingAfterstringoptionalOpaque Intercom cursor returned from a previous paginated response.
GET
intercom_get_article
Get a single Intercom help center article by identifier.

/articles/{articleId}

1 parameter
ParamTypeRequiredDescription
articleIdstringrequiredIntercom resource identifier.