REST API Reference

Intercom API (2.9)

The intercom API reference.

Download OpenAPI description

api.intercom.io.json

api.intercom.io.yaml

Overview

URL https://developers.intercom.com

License MIT

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

Teams

Everything about your Teams

Operations

Ticket Type Attributes

Everything about your ticket type attributes

Operations

Ticket Types

Everything about your ticket types

Operations

List all ticket types

Request

You can get a list of all ticket types for a workspace.

Headers

Intercom-Versionstring(intercom_version)

Intercom API version.
By default, it's equal to the version set in the app package.

Default 2.9

Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"

Example: 2.9

curl -i -X GET \
  https://api.intercom.io/ticket_types \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: 2.9'

Responses

successful

Bodyapplication/json

typestring

String representing the object's type. Always has the value ticket_type.list.

ticket_typesArray of objects or null(Ticket Type)

A list of ticket_types associated with a given workspace.

Response

application/json

{
  "type": "list",
  "data": [
    { … }
  ]
}

Create a ticket type

Request

You can create a new ticket type.

📘 Creating ticket types.
Every ticket type will be created with two default attributes: default_title and default_description. For the icon propery, use an emoji from Twemoji Cheatsheet

Headers

Intercom-Versionstring(intercom_version)

Intercom API version.
By default, it's equal to the version set in the app package.

Default 2.9

Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"

Example: 2.9

Bodyapplication/json

namestringrequired

The name of the ticket type.

Example: "Bug"

descriptionstring

The description of the ticket type.

Example: "Used for tracking bugs"

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

curl -i -X POST \
  https://api.intercom.io/ticket_types \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Intercom-Version: 2.9' \
  -d '{
    "name": "Customer Issue",
    "description": "Customer Report Template",
    "icon": "🎟️"
  }'

Responses

Ticket type created

Bodyapplication/json

typestring

String representing the object's type. Always has the value ticket_type.

Example: "ticket_type"

idstring

The id representing the ticket type.

Example: "1295"

namestring

The name of the ticket type

Example: "Bug"

descriptionstring

The description of the ticket type

Example: "A bug that has been reported."

iconstring

The icon of the ticket type

Example: "🐞"

workspace_idstring

The id of the workspace that the ticket type belongs to.

Example: "ecahpwf5"

ticket_type_attributesobject(Ticket Type Attributes)

A list of attributes associated with a given ticket type.

archivedboolean

Whether the ticket type is archived or not.

Example: false

created_atinteger(timestamp)

The date and time the ticket type was created.

updated_atinteger(timestamp)

The date and time the ticket type was last updated.

Response

application/json

{
  "type": "ticket_type",
  "id": "58",
  "name": "Customer Issue",
  "description": "Customer Report Template",
  "icon": "🎟️",
  "workspace_id": "this_is_an_id621_that_should_be_at_least_",
  "archived": false,
  "created_at": 1717021658,
  "updated_at": 1717021658,
  "is_internal": false,
  "ticket_type_attributes": {
    "type": "list",
    "data": [ … ]
  }
}

Retrieve a ticket type

Request

You can fetch the details of a single ticket type.

Path

idstringrequired

The unique identifier for the ticket type which is given by Intercom.

Headers

Intercom-Versionstring(intercom_version)

Intercom API version.
By default, it's equal to the version set in the app package.

Default 2.9

Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"

Example: 2.9

curl -i -X GET \
  'https://api.intercom.io/ticket_types/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Intercom-Version: 2.9'

Responses

Ticket type found

Bodyapplication/json

typestring

String representing the object's type. Always has the value ticket_type.

Example: "ticket_type"

idstring

The id representing the ticket type.

Example: "1295"

namestring

The name of the ticket type

Example: "Bug"

descriptionstring

The description of the ticket type

Example: "A bug that has been reported."

iconstring

The icon of the ticket type

Example: "🐞"

workspace_idstring

The id of the workspace that the ticket type belongs to.

Example: "ecahpwf5"

ticket_type_attributesobject(Ticket Type Attributes)

A list of attributes associated with a given ticket type.

archivedboolean

Whether the ticket type is archived or not.

Example: false

created_atinteger(timestamp)

The date and time the ticket type was created.

updated_atinteger(timestamp)

The date and time the ticket type was last updated.

Response

application/json

{
  "type": "ticket_type",
  "id": "60",
  "name": "Bug Report",
  "description": "Bug Report Template",
  "icon": "🎟️",
  "workspace_id": "this_is_an_id625_that_should_be_at_least_",
  "archived": false,
  "created_at": 1717021659,
  "updated_at": 1717021659,
  "is_internal": false,
  "ticket_type_attributes": {
    "type": "list",
    "data": [ … ]
  }
}

Update a ticket type

Request

You can update a ticket type.

📘 Updating a ticket type.
For the icon propery, use an emoji from Twemoji Cheatsheet

Path

idstringrequired

The unique identifier for the ticket type which is given by Intercom.

Headers

Intercom-Versionstring(intercom_version)

Intercom API version.
By default, it's equal to the version set in the app package.

Default 2.9

Enum"1.0""1.1""1.2""1.3""1.4""2.0""2.1""2.2""2.3""2.4"

Example: 2.9

Bodyapplication/json

namestring

The name of the ticket type.

Example: "Bug"

descriptionstring

The description of the ticket type.

Example: "A bug has been occured"

iconstring

The icon of the ticket type.

Default "🎟️"

Example: "🐞"

archivedboolean

The archived status of the ticket type.

Example: false

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

curl -i -X PUT \
  'https://api.intercom.io/ticket_types/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Intercom-Version: 2.9' \
  -d '{
    "name": "Bug Report 2"
  }'

Responses

Ticket type updated

Bodyapplication/json

typestring

String representing the object's type. Always has the value ticket_type.

Example: "ticket_type"

idstring

The id representing the ticket type.

Example: "1295"

namestring

The name of the ticket type

Example: "Bug"

descriptionstring

The description of the ticket type

Example: "A bug that has been reported."

iconstring

The icon of the ticket type

Example: "🐞"

workspace_idstring

The id of the workspace that the ticket type belongs to.

Example: "ecahpwf5"

ticket_type_attributesobject(Ticket Type Attributes)

A list of attributes associated with a given ticket type.

archivedboolean

Whether the ticket type is archived or not.

Example: false

created_atinteger(timestamp)

The date and time the ticket type was created.

updated_atinteger(timestamp)

The date and time the ticket type was last updated.

Response

application/json

{
  "type": "ticket_type",
  "id": "62",
  "name": "Bug Report 2",
  "description": "Bug Report Template",
  "icon": "🎟️",
  "workspace_id": "this_is_an_id629_that_should_be_at_least_",
  "archived": false,
  "created_at": 1717021660,
  "updated_at": 1717021661,
  "is_internal": false,
  "ticket_type_attributes": {
    "type": "list",
    "data": [ … ]
  }
}

Tickets

Everything about your tickets

Operations

Visitors

Everything about your Visitors

Operations

Intercom API (2.9)

Admins

Articles

Companies

Contacts

Conversations

Data Attributes

Data Events

Data Export

Help Center

Messages

News

Notes

Segments

Subscription Types

Switch

Tags

Teams

Ticket Type Attributes

Ticket Types

List all ticket types

Request

Responses

Was this page helpful?

Create a ticket type

Request

Responses

Was this page helpful?

Retrieve a ticket type

Request

Responses

Was this page helpful?

Update a ticket type

Request

Responses

Was this page helpful?

Tickets

Visitors

Models