• Installs:
  • Today: 66
  • All Time: 14653
Developer:uservolodimir.kudriachenko

Intercom API Package

Access data and build integrations for this chat app.

List of Endpoints
This is the list of endpoints this API includes. To add any of the endpoints to your app, please click on “Connect to endpoint” text.
See All
List of Webhook Events
This is the list of webhook events this API provides. Webhooks allow you to register to certain events and receive real-time data over websockets.
See All
Discussions
See All
Readme

Intercom

Intercom Package

Connect to the Intercom Customer Service API to access data and build integrations for this chat app. Test an API call and export the code snippet into your app.

  • Domain: Intercom
  • Credentials: clientId, clientSecret

How to get credentials:

  1. Sign up in Intercom.
  2. Navigate to Settings -> App settings(on the top left) -> Developer tools.
  3. Create "Access token" or "OAuth App".
  4. If you choose "OAuth App", copy clientId and clientSecret and use them to generate Access token.

Custom datatypes:

DatatypeDescriptionExample
DatepickerString which includes date and time2016-05-28 00:00:00
MapString which includes latitude and longitude coma separated50.37, 26.56
ListSimple array["123", "sample"]
SelectString with predefined valuessample
ArrayArray of objects[{"Second name":"123","Age":"12","Photo":"sdf","Draft":"sdfsdf"},{"name":"adi","Second name":"bla","Age":"4","Photo":"asfserwe","Draft":"sdfsdf"}]

Webhook credentials

Please use SDK to test this feature.

  1. Go to RapidAPI
  2. Log in or create an account
  3. Go to My apps
  4. Add new project with projectName to get your project Key
FieldTypeDescription
projectNamecredentialsYour RapidAPI project name
projectKeycredentialsYour RapidAPI project key

Intercom.getAccessToken

Fetch access token.

FieldTypeDescription
clientIdcredentialsClient identifier from your credentials.
clientSecretcredentialsClient secret from your credentials.
codeStringThis is automatically passed by the redirect.

Intercom.createUserByEmail

Create user by email.

FieldTypeDescription
accessTokenStringAccess token.
emailStringThe user's email address.
userIdStringA unique string identifier for the user.
phoneStringThe user's phone number.
nameStringThe user's full name.
lastSeenIpStringAn ip address.
customAttributesJSONJSON Object, a hash of key - value pairs containing any other data about the user you want Intercom to store.
lastSeenUserAgentStringThe user agent the user last visited your application with.
companiesListArray of JSON objects of companies.
lastRequestAtDatePickerThe date the user last visited your application
updateLastRequestAtBooleanIf true, instructs Intercom to update the user's last_request_at value.
newSessionBooleanIf true, instructs Intercom to register the request as a session.

Intercom.createUserById

Create user by identifier.

FieldTypeDescription
accessTokenStringAccess token.
userIdStringA unique string identifier for the user.
emailStringThe user's email address.
phoneStringThe user's phone number.
nameStringThe user's full name.
lastSeenIpStringAn ip address.
customAttributesJSONJSON Object, a hash of key - value pairs containing any other data about the user you want Intercom to store.
lastSeenUserAgentStringThe user agent the user last visited your application with.
companiesListArray of JSON objects of companies.
lastRequestAtDatePickerThe date the user last visited your application
updateLastRequestAtBooleanIf true, instructs Intercom to update the user's last_request_at value.
newSessionBooleanIf true, instructs Intercom to register the request as a session.

Intercom.updateUserByEmail

Update user by email.

FieldTypeDescription
accessTokenStringAccess token.
emailStringThe user's email address.
userIdStringA unique string identifier for the user.
phoneStringThe user's phone number.
nameStringThe user's full name.
lastSeenIpStringAn ip address.
customAttributesJSONJSON Object, a hash of key - value pairs containing any other data about the user you want Intercom to store.
lastSeenUserAgentStringThe user agent the user last visited your application with.
companiesListArray of JSON objects of companies.
lastRequestAtDatePickerThe date the user last visited your application
updateLastRequestAtBooleanIf true, instructs Intercom to update the user's last_request_at value.
newSessionBooleanIf true, instructs Intercom to register the request as a session.

Intercom.updateUserById

Update user by identifier.

FieldTypeDescription
accessTokenStringAccess token.
userIdStringA unique string identifier for the user.
emailStringThe user's email address.
phoneStringThe user's phone number.
nameStringThe user's full name.
lastSeenIpStringAn ip address.
customAttributesJSONJSON Object, a hash of key - value pairs containing any other data about the user you want Intercom to store.
lastSeenUserAgentStringThe user agent the user last visited your application with.
companiesListArray of JSON objects of companies.
lastRequestAtDateTickerThe date the user last visited your application
updateLastRequestAtBooleanIf true, instructs Intercom to update the user's last_request_at value.
newSessionBooleanIf true, instructs Intercom to register the request as a session.

Intercom.getUsers

Fetch a list of users.

FieldTypeDescription
accessTokenStringAccess token.
pageStringwhat page of results to fetch.
perPageStringhow many results per page.
orderStringReturn the users in ascending or descending order. One of: asc, desc.
sortSelectwhat field to sort the results by. One of: created_at, last_request_at, signed_up_at, updated_at.
createdSinceStringlimit results to users that were created in that last number of days.

Intercom.getUsersByTag

Fetch segmented users or leads by tag.

FieldTypeDescription
accessTokenStringAccess token.
tagIdStringThe identifier of the tag to filter by.

Intercom.getUsersBySegment

Fetch segmented users or leads by segment.

FieldTypeDescription
accessTokenStringAccess token.
segmentIdStringThe identifier of the segment to filter by.

Intercom.getSingleUser

Retrieve user by identifier.

FieldTypeDescription
accessTokenStringAccess token.
userIdStringThe user identifier.
userIdTypeSelectThe user identifier type. One of: intercom_id, user_id, email.

Intercom.deleteUser

Delete user.

FieldTypeDescription
accessTokenStringAccess token.
userIdStringThe user identifier.
userIdTypeSelectThe user identifier type. One of: intercom_id, user_id, email.

Intercom.scrollUsers

Scroll over all users.

FieldTypeDescription
accessTokenStringAccess token.
scrollParamStringScroll parameter.

Intercom.createLead

Create lead.

FieldTypeDescription
accessTokenStringAccess token.
nameStringThe name of the Lead.
userIdStringIdentifier for the Lead.
emailStringThe email you have defined for the Lead.
phoneStringThe phone number you have defined for the lead.
avatarImageUrlStringAn avatar URL for the Lead.
userAgentDataStringData about the last user agent the Lead was seen using.
lastSeenIpStringAn ip address.
companiesListArray of JSON objects of companies.
socialProfilesListArray of JSON objects, of social profiles associated with the Lead.
segmentsListArray of segments the Lead.
tagsStringArray of tags associated with the Lead.
customAttributesJSONJSON Object. The custom attributes you have set on the Lead.
locationDataJSONJSON Object, of Location, relating to the Lead.

Intercom.updateLead

Update lead.

FieldTypeDescription
accessTokenStringAccess token.
userIdStringIdentifier for the Lead.
nameStringThe name of the Lead.
emailStringThe email you have defined for the Lead.
phoneStringThe phone number you have defined for the lead.
avatarImageUrlStringAn avatar URL for the Lead.
userAgentDataStringData about the last user agent the Lead was seen using.
lastSeenIpStringAn ip address.
companiesListArray of JSON objects of companies.
socialProfilesListArray of JSON objects, of social profiles associated with the Lead.
segmentsListArray of segments the Lead.
tagsListArray of tags associated with the Lead.
customAttributesJSONJSON Object. The custom attributes you have set on the Lead.
locationDataJSONJSON Object, of Location, relating to the Lead.

Intercom.getLeads

Fetch a list of all leads.

FieldTypeDescription
accessTokenStringAccess token.

Intercom.getLeadsByEmail

Fetch all Leads with a given email.

FieldTypeDescription
accessTokenStringAccess token.
emailStringEmail for fetch.

Intercom.getSingleLead

Fetch single lead.

FieldTypeDescription
accessTokenStringAccess token.
userIdStringThe lead identifier.
userIdTypeSelectThe lead identifier type. One of: intercom_id, user_id, email.

Intercom.deleteLead

Delete lead.

FieldTypeDescription
accessTokenStringAccess token.
userIdStringThe lead identifier.
userIdTypeSelectThe lead identifier type. One of: intercom_id, user_id, email.

Intercom.convertLeadToUser

Convert Lead to Users.

FieldTypeDescription
accessTokenStringAccess token.
leadIdStringThe lead identifier.
leadIdTypeSelectThe user identifier type. One of: intercom_id, user_id, email.
userIdStringIdentifier of existing User.

Intercom.scrollLeads

Scroll over all Leads.

FieldTypeDescription
accessTokenStringAccess token.
scrollParamStringScroll parameter.

Intercom.createCompany

Create company.

FieldTypeDescription
accessTokenStringAccess token.
nameStringThe name of the company.
companyIdStringThe company id you have defined for the company.
monthlySpendStringHow much revenue the company generates for your business.
planStringThe name of the plan you have associated with the company.
customAttributesJSONJSON Object, a hash of key - value pairs containing any other data about the company you want Intercom to store.

Intercom.updateCompany

Update company.

FieldTypeDescription
accessTokenStringAccess token.
companyIdStringThe company identifier.
nameStringThe name of the company.
monthlySpendStringHow much revenue the company generates for your business.
planStringThe name of the plan you have associated with the company.
customAttributesJSONJSON Object, a hash of key - value pairs containing any other data about the company you want Intercom to store.

Intercom.getCompanies

Fetch a list of companies.

FieldTypeDescription
accessTokenStringAccess token.
pageNumberWhat page of results to fetch.
perPageNumberHow many results per page.
orderStringReturn the companies in ascending or descending order. One of: asc, desc.

Intercom.getCompaniesByTag

Fetch tagged companies by tag.

FieldTypeDescription
accessTokenStringAccess token.
tagIdStringThe identifier of the tag to filter by.

Intercom.getCompaniesBySegment

Fetch segmented companies by segment.

FieldTypeDescription
accessTokenStringAccess token.
segmentIdStringThe identifier of the segment to filter by.

Intercom.getSingleCompany

Fetch single company.

FieldTypeDescription
accessTokenStringAccess token.
companyIdStringThe company identifier, you have given to the company.

Intercom.getCompanyUsers

Fetch users that belong to a company.

FieldTypeDescription
accessTokenStringAccess token.
companyIdStringYour company identifier for the company.

Intercom.scrollCompanies

Scroll over all companies.

FieldTypeDescription
accessTokenStringAccess token.
scrollParamStringScroll parameter.

Intercom.getAdmins

fetching App's admins.

FieldTypeDescription
accessTokenStringAccess token.

Intercom.getCurrentAdmin

Fetching current admin of app.

FieldTypeDescription
accessTokenStringAccess token.

Intercom.getSingleAdmin

Fetching one admin of app.

FieldTypeDescription
accessTokenStringAccess token.
adminIdStringAdmins identifier.

Intercom.createTag

Create tag.

FieldTypeDescription
accessTokenStringAccess token.
nameStringThe name of the tag.

Intercom.updateTag

Update tag.

FieldTypeDescription
accessTokenStringAccess token.
idStringThe identifier of tag to updates.
nameStringNew name of the tag.

Intercom.tagUser

Add tag to User.

FieldTypeDescription
accessTokenStringAccess token.
nameStringThe name of the tag.
usersListArray of JSON objects, of users user_id, intercom identifier or email.

Intercom.untagUsers

Remove tag from User.

FieldTypeDescription
accessTokenStringAccess token.
nameStringThe name of the tag.
usersListArray of JSON objects, of users user_id, intercom identifier or email.

Intercom.tagCompany

Add tag to Company.

FieldTypeDescription
accessTokenStringAccess token.
nameStringThe name of the tag.
companiesListArray of JSON objects, of companies company_id or intercom identifier.

Intercom.untagCompany

Remove tag from Company.

FieldTypeDescription
accessTokenStringAccess token.
nameStringThe name of the tag.
companiesListArray of JSON objects, of companies company_id or intercom identifier.

Intercom.deleteTag

Delete tag.

FieldTypeDescription
accessTokenStringAccess token.
tagIdStringTag identifier.

Intercom.getAppTags

Fetch tags of App.

FieldTypeDescription
accessTokenStringAccess token.

Intercom.getSegments

Fetch list the user segments.

FieldTypeDescription
accessTokenStringAccess token.

Intercom.getSingleSegment

Fetch single segments.

FieldTypeDescription
accessTokenStringAccess token.
segmentIdStringSegment identifier.

Intercom.createNote

Create a Note.

FieldTypeDescription
accessTokenStringAccess token.
userIdStringUser identifier the note is to be created about.
userIdTypeSelectThe user identifier type. One of: intercom_id, user_id, email.
bodyStringThe text of the note.
adminIdStringThe identifier of the admin creating the note.

Intercom.getUserNotes

List Notes for a User.

FieldTypeDescription
accessTokenStringAccess token.
userIdStringThe user identifier.
userIdTypeSelectThe user identifier type. One of: intercom_id, user_id, email.

Intercom.getSingleNote

Fetch single Note.

FieldTypeDescription
accessTokenStringAccess token.
noteIdStringThe note identifier.

Intercom.submitEvent

Submitting Events.

FieldTypeDescription
accessTokenStringAccess token.
eventNameStringThe name of the event that occurred.
userIdStringYour identifier for the the user.
createdAtDatePickerThe time the event occurred
metadataJSONJSON Object, metadata about the event.

Intercom.getUserEvents

The events belonging to a user.

FieldTypeDescription
accessTokenStringAccess token.
userIdStringThe user identifier.

Intercom.getUserEventsSummaries

View User Event Summaries.

FieldTypeDescription
accessTokenStringAccess token.
userIdStringThe user identifier.

Intercom.getAppTotalCounts

Fetch app total counts.

FieldTypeDescription
accessTokenStringAccess token.
typeSelectType of counts. One of: user, company, conversation.

Intercom.getAppConversationCount

Fetch app conversation count.

FieldTypeDescription
accessTokenStringAccess token.

Intercom.getAdminConversationsCount

Fetch admin conversations count.

FieldTypeDescription
accessTokenStringAccess token.

Intercom.getUserSegmensCount

Fetch user segmens count.

FieldTypeDescription
accessTokenStringAccess token.

Intercom.getUserTagsCount

Fetch user tags count.

FieldTypeDescription
accessTokenStringAccess token.

Intercom.getCompanySegmentsCount

Fetch company segments count.

FieldTypeDescription
accessTokenStringAccess token.

Intercom.getCompanyTagsCount

Fetch company tags count.

FieldTypeDescription
accessTokenStringAccess token.

Intercom.getCompanyUsersCount

Fetch company users count.

FieldTypeDescription
accessTokenStringAccess token.

Intercom.createAdminMessage

Create an admin initiated message to a user.

FieldTypeDescription
accessTokenStringAccess token.
fromAdminIdStringAdmin identifier from whom send message.
receiverTypeSelectReceiver type. One of: user, contact.
receiverIdStringThe receiver identifier.
receiverIdTypeSelectThe receiver identifier type. One of: intercom_id, user_id, email.
messageTypeSelectThe kind of message being created. One of: inapp, email.
subjectStringThe title of the email.
bodyStringThe content of the message. Plaintext only, HTML is not supported.
templateSelectThe style of the outgoing message. Only valid for email messages. One of: plain, personal.

Intercom.createUserMessage

Create user message.

FieldTypeDescription
accessTokenStringAccess token.
senderIdStringThe sender identifier.
senderIdTypeSelectThe sender identifier type. One of: intercom_id, user_id, email.
bodyStringThe content of the message. Plaintext only, HTML is not supported.

Intercom.createContactMessage

Create contact message.

FieldTypeDescription
accessTokenStringAccess token.
senderIdStringThe sender identifier.
senderIdTypeSelectThe sender identifier type. One of: intercom_id, user_id.
bodyStringThe content of the message. Plaintext only, HTML is not supported.

Intercom.getConversations

Fetch a list of all conversations.

FieldTypeDescription
accessTokenStringAccess token.

Intercom.getSingleAdminConversations

Fetch conversations for single admin.

FieldTypeDescription
accessTokenStringAccess token.
adminIdStringAdmin identifier.
openBooleanwhen true fetches just open conversations, when false just closed conversations.

Intercom.getSingleUserConversations

Fetch conversations with single user.

FieldTypeDescription
accessTokenStringAccess token.
userIdStringThe user identifier.
userIdTypeSelectThe user identifier type. One of: intercom_user_id, user_id, email.

Intercom.getSingleConversation

Fetch single conversation.

FieldTypeDescription
accessTokenStringAccess token.
conversationIdStringConversation identifier.

Intercom.replyToUserComment

Replying to a Conversation.

FieldTypeDescription
accessTokenStringAccess token.
conversationIdStringConversation identifier.
bodyStringThe text body of the comment.
userIdStringThe user identifier.
userIdTypeSelectThe user identifier type. One of: intercom_user_id, user_id, email.
attachmentUrlsListArray of Strings of URLs of files that will be added as attachments. You can include up to 5 attachments.

Intercom.replyToAdminComment

Reply to admin comment.

FieldTypeDescription
accessTokenStringAccess token.
conversationIdStringConversation identifier.
adminIdStringThe identifier of the Admin who is authoring the comment.
bodyStringThe text body of the comment.
attachmentUrlsListArray of Strings of URLs of files that will be added as attachments. You can include up to 5 attachments.

Intercom.replyToUsersLastConversation

Reply to users last conversation.

FieldTypeDescription
accessTokenStringAccess token.
intercomUserIdStringThe user identifier.
adminIdStringThe identifier of the Admin who is replying.
bodyStringThe text body of the comment.
attachmentUrlsListArray of Strings of URLs of files that will be added as attachments. You can include up to 5 attachments.

Intercom.markConversationAsRead

Marking a Conversation as Read.

FieldTypeDescription
accessTokenStringAccess token.
conversationIdStringConversation identifier.

Intercom.closeConversation

Closing a conversation.

FieldTypeDescription
accessTokenStringAccess token.
conversationIdStringConversation identifier.
adminIdStringAdmin identifier.

Intercom.getSingleVisitor

Fetch single visitor.

FieldTypeDescription
accessTokenStringAccess token.
userIdStringVisitor user identifier.
userIdTypeSelectVisitor user identifier type. One of: intercom_id, user_id.

Intercom.updateVisitor

Update a Visitor.

FieldTypeDescription
accessTokenStringAccess token.
userIdStringUser identifier for the Visitor.
nameStringThe name of the Visitor.
customAttributesJSONJSON Object, the custom attributes you have set on the Visitor.
lastRequestAtDatePickerThe date the lead last visited your application
avatarImageUrlStringAn avatar image URL for the Visitor.
unsubscribedFromEmailsBooleanWhether the Visitor is unsubscribed from emails.
locationDataJSONJSON Object. Location relating to the Visitor.
userAgentDataStringData about the last user agent the Visitor was seen using.
lastSeenIpStringAn ip address.
socialProfilesListArray of JSON objects, of social profiles associated with the Visitor.
segmentsListArray of segments the Visitor.
tagsListArray of tags associated with the Visitor.

Intercom.deleteVisitor

Delete a visitor.

FieldTypeDescription
accessTokenStringAccess token.
userIdStringUser identifier for the Visitor.

Intercom.convertVisitorToLead

Convert Visitor to Leads.

FieldTypeDescription
accessTokenStringAccess token.
visitorUserIdStringUser identifier for the Visitor.
visitorUserIdTypeSelectThe Visitor user identifier of type. One of: intercom_id, user_id, email.
leadIdStringUser identifier for the Lead to binding.

Intercom.createSubscription

Create new subscription.

FieldTypeDescription
accessTokenStringAccess token.
urlStringThe url the event should be sent to.
topicsListComma-separated list of topics to subscribe to.
serviceTypeStringThe type of the service being called. Default is web.
hubSecretStringA key used to sign notifications.

Intercom.getSingleSubscription

Fetch single subscription.

FieldTypeDescription
accessTokenStringAccess token.
subscriptionIdStringSubscription identifier.

Intercom.getSubscriptions

Fetch list of subscriptions.

FieldTypeDescription
accessTokenStringAccess token.

Intercom.getErrorFeed

Fetch feed of errors returned by the webhook.

FieldTypeDescription
accessTokenStringAccess token.
subscriptionIdStringSubscription identifier.

Intercom.getSentFeed

Fetch feed of notifications sent.

FieldTypeDescription
accessTokenStringAccess token.
subscriptionIdStringSubscription identifier.

Intercom.pingSubscription

Ping subscription.

FieldTypeDescription
accessTokenStringAccess token.
subscriptionIdStringSubscription identifier.

Intercom.createEventWebhookSubscription

Create an Event Webhook Subscription. You can use our service as url:

https://webhooks.rapidapi.com/api/message/Intercom/webhookEvent/{projectName}/{projectKey} * see credentials description above
FieldTypeDescription
accessTokenStringAccess token.
metadataEventNamesListArray of events name to subscribe to.
urlStringThe url the event should be sent to.
serviceTypeStringThe type of the service being called. Default is web.

Intercom.updateEventWebhookSubscription

Update an Event Webhook Subscription. You can use our service as url:

https://webhooks.rapidapi.com/api/message/Mandrill/webhookEvent/{projectName}/{projectKey} * see credentials description above
FieldTypeDescription
accessTokenStringAccess token.
metadataEventNamesListArray of events name to subscribe to.
urlStringThe url the event should be sent to.
serviceTypeStringThe type of the service being called. Default is web.

Intercom.createUserBulkJobs

Creating bulk jobs for users.

FieldTypeDescription
accessTokenStringAccess token.
itemsListArray of object, of users tasks.

Intercom.createBulkLeadJob

Bulk Lead Posting.

FieldTypeDescription
accessTokenStringAccess token.
itemsListArray of object, of Leads.

Intercom.createBulkEventJob

Bulk Event Posting.

FieldTypeDescription
accessTokenStringAccess token.
itemsListArray of object, of Events.

Intercom.getSingleBulkJob

Fetch single job.

FieldTypeDescription
accessTokenStringAccess token.
jobIdStringBulk job identifier.
x
circle
Intercom
$ / m
We will charge your card every month for the plan amount, as well as any overages incurred in the previous month.
?

Oops, we are missing some details

Looks like there are a few missing details that you haven't filled in yet.
These details are important and will help us protect you and let you know about anything new.

x

Why sign up to RapidAPI?

  • integrate
    Integrate APIs into your app
    Ruby, Java, Elixir, Node.js, Phyton, Objective C, Swift, PHP and MORE
  • keys
    Save all API keys in one place
  • notifications
    Get notifications about API changes
  • stats
    Get stats and monitor API connections
__SING_UP_WITH_GITHUB__
__SING_UP_WITH_FACEBOOK__
__SING_UP_WITH_GOOGLE__
  • We're not going to post anything on your wall.
  • We're not planning to spam you.
  • esccloses this view
    x

    Authentication

    Authenticate
    esccloses this view