Home
/
REST API Reference
/
Models
/
Segment List

Intercom API (2.10)

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

Search data

Search using Intercoms Search APIs.

querySingle Filter Search Request (object) or Multiple Filter Search Request (object)required
One of:

Search using Intercoms Search APIs with a single filter.

query.​fieldstring

The accepted field that you want to search on.

Example: "created_at"
query.​operatorstring

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

Enum"=""!=""IN""NIN""<"">""~""!~""^""$"
Example: ">"
query.​value(string or null) or (integer or null) or (Array of strings or integers or null)

The value that you want to search on.

Example: "73732934"
One of:

The value that you want to search on.

string or null

The value that you want to search on.

paginationobject or null(Pagination: Starting After)
{
  "query": {
    "field": "created_at",
    "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.

typestring

The type of the object

Value"segment.list"
Example: "segment.list"
segmentsArray of objects(Segment)

A list of Segment objects

pagesobject

A pagination object, which may be empty, indicating no further pages to fetch.

{
  "type": "segment.list",
  "segments": [
    { … }
  ],
  "pages": {}
}

Single Filter Search Request

Search using Intercoms Search APIs with a single filter.

fieldstring

The accepted field that you want to search on.

Example: "created_at"
operatorstring

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

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

The value that you want to search on.

Example: "73732934"
One of:

The value that you want to search on.

string or null

The value that you want to search on.

{
  "field": "created_at",
  "operator": ">",
  "value": "73732934"
}