Skip to content
Home
/
REST API Reference
/
Models
/
Applied SLA

Intercom API (2.11)

The intercom API reference.

Download OpenAPI description
api.intercom.io.json
api.intercom.io.yaml
Overview
URL

https://developers.intercom.com

License

MIT

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/

Admins

Everything about your Admins

Operations

Articles

Everything about your Articles

Operations

Companies

Everything about your Companies

Operations

Contacts

Everything about your contacts

Operations

Conversations

Everything about your Conversations

Operations

Data Attributes

Everything about your Data Attributes

Operations

Data Events

Everything about your Data Events

Operations

Data Export

Everything about your Data Exports

Operations

Help Center

Everything about your Help Center

Operations

Messages

Everything about your messages

Operations

News

Everything about your News

Operations

Notes

Everything about your Notes

Operations

Segments

Everything about your Segments

Operations

Subscription Types

Everything about subscription types

Operations

Switch

Everything about Switch

Operations

Tags

Everything about tags

Operations

Teams

Everything about your Teams

Operations

Ticket Type Attributes

Everything about your ticket type attributes

Operations

Ticket Types

Everything about your ticket types

Operations

Tickets

Everything about your tickets

Operations

Visitors

Everything about your Visitors

Operations

Models

Single Filter Search Request

Search using Intercoms Search APIs with a single filter.

fieldstring

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"
operatorstring

The accepted operators you can use to define how you want to search for the value.

Enum"=""!=""IN""NIN""<"">""~""!~""^""$"
Example: ">"
valuestring or integer or (Array of strings or integers)

The value that you want to search on.

Example: "73732934"
One of:

The value that you want to search on.

string

The value that you want to search on.

{
  "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.

typestringrequired

object type

Example: "conversation_sla_summary"
sla_namestringrequired

The name of the SLA as given by the teammate when it was created.

Example: ""
sla_statusstringrequired

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"
}

Snooze Conversation Request

Payload of the request to snooze a conversation

message_typestringrequired
Value"snoozed"
Example: "snoozed"
admin_idstringrequired

The id of the admin who is performing the action.

Example: "5017691"
snoozed_untilinteger(timestamp)required

The time you want the conversation to reopen.

Example: 1673609604
{
  "message_type": "snoozed",
  "admin_id": "5017691",
  "snoozed_until": 1673609604
}