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/
Search data
Search using Intercoms Search APIs.
One 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: ">"
{ "query": { "field": "custom_attributes.favorite_color", "operator": ">", "value": "73732934" }, "pagination": { "per_page": 2, "starting_after": "your-cursor-from-response" } }
Segment List
This will return a list of Segment Objects. The result may also have a pages object if the response is paginated.
A list of Segment objects
The unique identifier representing the segment.
Example: "56203d253cba154d39010062"
Type of the contact: contact (lead) or user.
Enum"contact""user"
Example: "contact"
{ "type": "segment.list", "segments": [ { … } ], "pages": {} }
Single Filter Search Request
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" }