Retrieve a ticket

You can fetch the details of a single ticket.

SecurityHTTP: bearerAuth
Request
path Parameters
id
required
string

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

header Parameters
Intercom-Version
string (intercom_version)
Default: 2.11

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

Enum: "1.0" "1.1" "1.2" "1.3" "1.4" "2.0" "2.1" "2.2" "2.3" "2.4" "2.5" "2.6" "2.7" "2.8" "2.9" "2.10" "2.11" "Unstable"
Example: 2.11
get
/tickets/{id}
Request samples
Responses

200

Ticket found

Response Schema: application/json
type
string
Default: "ticket"

Always ticket

Value: "ticket"
id
string

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

ticket_id
string

The ID of the Ticket used in the Intercom Inbox and Messenger. Do not use ticket_id for API queries.

category
string

Category of the Ticket.

Enum: "Customer" "Back-office" "Tracker"
object (Ticket Attributes)

An object containing the different attributes associated to the ticket as key-value pairs. For the default title and description attributes, the keys are _default_title_ and _default_description_.

ticket_state
string

The state the ticket is currenly in

Enum: "submitted" "in_progress" "waiting_on_customer" "resolved"
ticket_state_internal_label
string

The state the ticket is currently in, in a human readable form - visible in Intercom

ticket_state_external_label
string

The state the ticket is currently in, in a human readable form - visible to customers, in the messenger, email and tickets portal.

object or null (Ticket Type)

A ticket type, used to define the data fields to be captured in a ticket.

object (Contacts)

The list of contacts affected by a ticket.

admin_assignee_id
string

The id representing the admin assigned to the ticket.

team_assignee_id
string

The id representing the team assigned to the ticket.

created_at
integer <date-time>

The time the ticket was created as a UTC Unix timestamp.

updated_at
integer <date-time>

The last time the ticket was updated as a UTC Unix timestamp.

open
boolean

Whether or not the ticket is open. If false, the ticket is closed.

snoozed_until
integer <date-time>

The time the ticket will be snoozed until as a UTC Unix timestamp. If null, the ticket is not currently snoozed.

object (Linked Objects)

An object containing metadata about linked conversations and linked tickets. Up to 1000 can be returned.

object (Ticket Parts)

A list of Ticket Part objects for each note and event in the ticket. There is a limit of 500 parts.

is_shared
boolean

Whether or not the ticket is shared with the customer.

401

Unauthorized

Response samples
application/json
{ "type": "ticket", "id": "1268", "ticket_id": "89", "ticket_attributes": { "_default_title_": "attribute_value", "_default_description_": null }, "ticket_state": "submitted", "ticket_state_internal_label": "Submitted", "ticket_state_external_label": "Submitted", "ticket_type": { "type": "ticket_type", "id": "249", "name": "my-ticket-type-21", "description": "my ticket type description is awesome.", "icon": "🦁", "workspace_id": "this_is_an_id649_that_should_be_at_least_", "archived": false, "created_at": 1716385465, "updated_at": 1716385465, "is_internal": false, "category": "Back-office" }, "contacts": { "type": "contact.list", }, "admin_assignee_id": "0", "team_assignee_id": "0", "created_at": 1716385466, "updated_at": 1716385467, "ticket_parts": { "type": "ticket_part.list", "total_count": 1 }, "open": true, "linked_objects": { "type": "list", "data": [ ], "total_count": 0, "has_more": false }, "category": "Back-office", "is_shared": false }