Delete a company
Add subscription to a contact
Delete a collection
https://api.intercom.io/collections/<id>
.Add tag to a contact
Attach a contact to a company
List all admins
List all articles
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 collections
https://api.intercom.io/help center/collections
. 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.Delete a contact
List all help centers
https://api.intercom.io/help center/help centers
.Detach a contact from a company
List attached contacts
List attached companies for contact
Get a contact
List attached segments for companies
List all companies
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. {% admonition type=“warning” name=“pagination” %} you can use pagination to limit the number of results returned. the default is 20
results per page. see the pagination section for more details on how to use the starting after
param. {% /admonition %}List all notes
Identify an admin
/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.List all activity logs
Remove tag from a contact
List subscriptions for a contact
List attached segments for contact
List tags attached to a contact
Retrieve a collection
https://api.intercom.io/help center/collections/<id>
.Retrieve a help center
https://api.intercom.io/help center/help center/<id>
.Merge a lead and a user
role
of lead
into a contact with a role
of user
.Retrieve an article
https://api.intercom.io/articles/<id>
.Retrieve an admin
Retrieve companies
company id
or name
. https://api.intercom.io/companies?name=\{name\}
https://api.intercom.io/companies?company id=\{company id\}
you can fetch all companies and filter by segment id
or tag id
as a query parameter. https://api.intercom.io/companies?tag id=\{tag id\}
https://api.intercom.io/companies?segment id=\{segment id\}
Set an admin to away
Retrieve a company by id
Scroll over all companies
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. 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 type=“danger” name=“scroll network timeouts”. since scroll is often used on large datasets network errors such as timeouts can be encountered. 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.” if this happens, you will need to restart your scroll query.Remove subscription from a contact
Update a contact
Update a company
id
. {% admonition type=“attention” name=“using company id
” %} when updating a company it is not possible to update company id
. this can only be set once upon creation of the company. {% /admonition %}Search for articles
https://api.intercom.io/articles/search
.Create a note
Update a collection
https://api.intercom.io/collections/<id>
.Create or update a company
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. {% admonition type=“attention” name=“using company id
” %} you can set a unique company id
value when creating a company. however, it is not possible to update company id
. be sure to set a unique value once upon creation of the company. {% /admonition %}Create a collection
https://api.intercom.io/help center/collections.
Delete an article
https://api.intercom.io/articles/<id>
.Create an article
https://api.intercom.io/articles
.Update an article
https://api.intercom.io/articles/<id>
.