Skip to content
Home
/
REST API Reference
/
Models
/
Cursor based pages

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

Create Ticket Type Request Payload

The request payload for creating a ticket type. You can copy the icon property for your ticket type from Twemoji Cheatsheet

namestringrequired

The name of the ticket type.

Example: "Bug"
descriptionstring

The description of the ticket type.

Example: "Used for tracking bugs"
categorystring

Category of the Ticket Type.

Enum"Customer""Back-office""Tracker"
Example: "Customer"
iconstring

The icon of the ticket type.

Default "🎟️"
Example: "🐞"
is_internalboolean

Whether the tickets associated with this ticket type are intended for internal use only or will be shared with customers. This is currently a limited attribute.

Default false
Example: false
{
  "name": "Bug",
  "description": "Used for tracking bugs",
  "category": "Customer",
  "icon": "🐞",
  "is_internal": false
}

Cursor based pages

Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data. A "cursor" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or "pages" as needed.

typestring

the type of object pages.

Value"pages"
Example: "pages"
pageinteger

The current page

Example: 1
nextobject or null(Pagination: Starting After)
per_pageinteger

Number of results per page

Example: 2
total_pagesinteger

Total number of pages

Example: 13
{
  "type": "pages",
  "page": 1,
  "next": {
    "per_page": 2,
    "starting_after": "your-cursor-from-response"
  },
  "per_page": 2,
  "total_pages": 13
}

Custom Attributes

An object containing the different custom attributes associated to the conversation as key-value pairs. For relationship attributes the value will be a list of custom object instance models.

property name*string or (Custom Object Instance (object or null))additional property
Any of:
string
{
  "property1": "string",
  "property2": "string"
}