The intercom API reference.
Intercom API (2.11)
Download OpenAPI description
Overview
URL
License
Languages
Servers
The production API server
https://api.intercom.io/
The european API server
https://api.eu.intercom.io/
The australian API server
https://api.au.intercom.io/
Error
The API will return an Error List for a failed request, which will contain one or more Error objects.
An array of one or more error objects
A string indicating the kind of error, used to further qualify the HTTP response code
Example: "unauthorized"
Optional. Human readable description of the error.
Example: "Access Token Invalid"
{ "type": "error.list", "request_id": "f93ecfa8-d08a-4325-8694-89aeb89c8f85", "errors": [ { … } ] }
File
The value describing a file upload set for a custom attribute
The url of the file. This is a temporary URL and will expire after 30 minutes.
Example: "https://intercom-attachments-1.com/.../Screenshot.png"
{ "type": "upload", "name": "Screenshot.png", "url": "https://intercom-attachments-1.com/.../Screenshot.png", "content_type": "image/png", "filesize": 11308309, "width": 3024, "height": 1964 }
filter
Any of:
Search using Intercoms Search APIs with a single filter.
The accepted field that you want to search on.
Enum"id""role""name""avatar""owner_id""email""email_domain""phone""external_id""created_at"
Example: "custom_attributes.favorite_color"
The accepted operators you can use to define how you want to search for the value.
Enum"=""!=""IN""NIN""<"">""~""!~""^""$"
Example: ">"
{ "field": "custom_attributes.favorite_color", "operator": ">", "value": "73732934" }