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/
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" }
Applied SLA
The SLA Applied object contains the details for which SLA has been applied to this conversation. Important: if there are any canceled sla_events for the conversation - meaning an SLA has been manually removed from a conversation, the sla_status will always be returned as null.
SLA statuses:
hit: If there’s at least one hit event in the underlying sla_events table, and no “missed” or “canceled” events for the conversation.missed: If there are any missed sla_events for the conversation and no canceled events. If there’s even a single missed sla event, the status will always be missed. A missed status is not applied when the SLA expires, only the next time a teammate replies.active: An SLA has been applied to a conversation, but has not yet been fulfilled. SLA status is active only if there are no “hit, “missed”, or “canceled” events.
Enum"hit""missed""cancelled""active"
Example: "hit"
{ "type": "conversation_sla_summary", "sla_name": "", "sla_status": "hit" }