Skip to content
Home
/
REST API Reference
/
Models
/
filter

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

File

The value describing a file upload set for a custom attribute

typestringrequired
Example: "upload"
namestringrequired

The name of the file

Example: "Screenshot.png"
urlstringrequired

The url of the file. This is a temporary URL and will expire after 30 minutes.

Example: "https://intercom-attachments-1.com/.../Screenshot.png"
content_typestringrequired

The type of file

Example: "image/png"
filesizeintegerrequired

The size of the file in bytes

Example: 11308309
widthintegerrequired

The width of the file in pixels, if applicable

Example: 3024
heightintegerrequired

The height of the file in pixels, if applicable

Example: 1964
{
  "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.

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

Group Content

The Content of a Group.

typestringrequired

The type of object - group_content .

Value"group_content"
Example: "group_content"
namestringrequired

The name of the collection or section.

Example: "Collection name"
descriptionstringrequired

The description of the collection. Only available for collections.

Example: " Collection description"
{
  "type": "group_content",
  "name": "Collection name",
  "description": " Collection description"
}