Intercom: Get Ticket

Get an Intercom ticket by its ID, with its attributes, state and contacts.

Tool ID: intercom_get_ticket

Run this action

Use the TypeScript SDK for one call. Use ctx.tools.execute(...) inside a Play for durable calls, scheduled calls, or CSV processing.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'intercom_get_ticket',
  {
    "ticket_id": "ticket_123"
  },
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute intercom_get_ticket --input '{
  "ticket_id": "ticket_123"
}' --json

Example response

The SDK returns this shape at result.toolResponse.raw. The example values illustrate the response.

{
  "data": {
    "type": "ticket",
    "id": "id_123",
    "ticket_id": "ticket_123"
  }
}

Use deepline describe intercom_get_ticket --json for the latest machine-readable contract.

Input reference

You can fetch the details of a single ticket.

Name	Type	Required	Default	Details
`payload.ticket_id`	`string`	Yes	—	The unique identifier for the ticket which is given by Intercom. {% admonition type=“info” name=“Not the Inbox ticket ID” %} This is the internal `id` field from the API response, not the `ticket_id` displayed in the Intercom Inbox (e.g., #12345). Use the `id` value from the ticket object returned by the API. {% /admonition %}

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	Tickets are how you track requests from your users.
`result.data.type`	`"ticket"`	No	`"ticket"`	Always ticket Allowed: `ticket`.
`result.data.id`	`string`	No	—	The unique identifier for the ticket which is given by Intercom.
`result.data.ticket_id`	`string`	No	—	The ID of the Ticket used in the Intercom Inbox and Messenger. Do not use ticket_id for API queries.
`result.data.category`	`"Customer" \| "Back-office" \| "Tracker"`	No	—	Category of the Ticket. Allowed: `Customer`, `Back-office`, `Tracker`.
`result.data.ticket_attributes`	`record`	No	—	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_`.
`result.data.ticket_state`	`object \| null`	No	—	A ticket state, used to define the state of a ticket.
`result.data.ticket_state.type`	`string`	No	—	String representing the object’s type. Always has the value `ticket_state`.
`result.data.ticket_state.id`	`string`	No	—	The id of the ticket state
`result.data.ticket_state.category`	`"submitted" \| "in_progress" \| "waiting_on_customer" \| "resolved"`	No	—	The category of the ticket state Allowed: `submitted`, `in_progress`, `waiting_on_customer`, `resolved`.
`result.data.ticket_state.internal_label`	`string`	No	—	The state the ticket is currently in, in a human readable form - visible in Intercom
`result.data.ticket_state.external_label`	`string`	No	—	The state the ticket is currently in, in a human readable form - visible to customers, in the messenger, email and tickets portal.
`result.data.ticket_type`	`object \| null`	No	—	A ticket type, used to define the data fields to be captured in a ticket.
`result.data.ticket_type.type`	`string`	No	—	String representing the object’s type. Always has the value `ticket_type`.
`result.data.ticket_type.id`	`string`	No	—	The id representing the ticket type.
`result.data.ticket_type.category`	`"Customer" \| "Back-office" \| "Tracker"`	No	—	Category of the Ticket Type. Allowed: `Customer`, `Back-office`, `Tracker`.
`result.data.ticket_type.name`	`string`	No	—	The name of the ticket type
`result.data.ticket_type.description`	`string`	No	—	The description of the ticket type
`result.data.ticket_type.icon`	`string`	No	—	The icon of the ticket type
`result.data.ticket_type.workspace_id`	`string`	No	—	The id of the workspace that the ticket type belongs to.
`result.data.ticket_type.ticket_type_attributes`	`object`	No	—	A list of attributes associated with a given ticket type.
`result.data.ticket_type.ticket_type_attributes.type`	`string`	No	—	String representing the object’s type. Always has the value `ticket_type_attributes.list`.
`result.data.ticket_type.ticket_type_attributes.ticket_type_attributes`	`array`	No	—	A list of ticket type attributes associated with a given ticket type.
`result.data.ticket_type.ticket_type_attributes.ticket_type_attributes[].type`	`string`	No	—	String representing the object’s type. Always has the value `ticket_type_attribute`.
`result.data.ticket_type.ticket_type_attributes.ticket_type_attributes[].id`	`string`	No	—	The id representing the ticket type attribute.
`result.data.ticket_type.ticket_type_attributes.ticket_type_attributes[].workspace_id`	`string`	No	—	The id of the workspace that the ticket type attribute belongs to.
`result.data.ticket_type.ticket_type_attributes.ticket_type_attributes[].name`	`string`	No	—	The name of the ticket type attribute
`result.data.ticket_type.ticket_type_attributes.ticket_type_attributes[].description`	`string`	No	—	The description of the ticket type attribute
`result.data.ticket_type.ticket_type_attributes.ticket_type_attributes[].data_type`	`string`	No	—	The type of the data attribute (allowed values: “string list integer decimal boolean datetime files”)
`result.data.ticket_type.ticket_type_attributes.ticket_type_attributes[].input_options`	`record`	No	—	Input options for the attribute
`result.data.ticket_type.ticket_type_attributes.ticket_type_attributes[].order`	`integer`	No	—	The order of the attribute against other attributes
`result.data.ticket_type.ticket_type_attributes.ticket_type_attributes[].required_to_create`	`boolean`	No	`false`	Whether the attribute is required or not for teammates.
`result.data.ticket_type.ticket_type_attributes.ticket_type_attributes[].required_to_create_for_contacts`	`boolean`	No	`false`	Whether the attribute is required or not for contacts.
`result.data.ticket_type.ticket_type_attributes.ticket_type_attributes[].visible_on_create`	`boolean`	No	`true`	Whether the attribute is visible or not to teammates.
`result.data.ticket_type.ticket_type_attributes.ticket_type_attributes[].visible_to_contacts`	`boolean`	No	`true`	Whether the attribute is visible or not to contacts.
`result.data.ticket_type.ticket_type_attributes.ticket_type_attributes[].default`	`boolean`	No	—	Whether the attribute is built in or not.
`result.data.ticket_type.ticket_type_attributes.ticket_type_attributes[].ticket_type_id`	`integer`	No	—	The id of the ticket type that the attribute belongs to.
`result.data.ticket_type.ticket_type_attributes.ticket_type_attributes[].archived`	`boolean`	No	—	Whether the ticket type attribute is archived or not.
`result.data.ticket_type.ticket_type_attributes.ticket_type_attributes[].created_at`	`integer`	No	—	The date and time the ticket type attribute was created. Format: `timestamp`.
`result.data.ticket_type.ticket_type_attributes.ticket_type_attributes[].updated_at`	`integer`	No	—	The date and time the ticket type attribute was last updated. Format: `timestamp`.
`result.data.ticket_type.ticket_states`	`object`	No	—	A list of ticket states associated with a given ticket type.
`result.data.ticket_type.ticket_states.type`	`string`	No	—	String representing the object’s type. Always has the value `list`.
`result.data.ticket_type.ticket_states.data`	`array`	No	—	A list of ticket states associated with a given ticket type.
`result.data.ticket_type.ticket_states.data[].type`	`string`	No	—	String representing the object’s type. Always has the value `ticket_state`.
`result.data.ticket_type.ticket_states.data[].id`	`string`	No	—	The id of the ticket state
`result.data.ticket_type.ticket_states.data[].category`	`"submitted" \| "in_progress" \| "waiting_on_customer" \| "resolved"`	No	—	The category of the ticket state Allowed: `submitted`, `in_progress`, `waiting_on_customer`, `resolved`.
`result.data.ticket_type.ticket_states.data[].internal_label`	`string`	No	—	The state the ticket is currently in, in a human readable form - visible in Intercom
`result.data.ticket_type.ticket_states.data[].external_label`	`string`	No	—	The state the ticket is currently in, in a human readable form - visible to customers, in the messenger, email and tickets portal.
`result.data.ticket_type.archived`	`boolean`	No	—	Whether the ticket type is archived or not.
`result.data.ticket_type.created_at`	`integer`	No	—	The date and time the ticket type was created. Format: `timestamp`.

The table shows the first 50 fields. Use the live contract below for every field.

This output schema is too large for an inline display. Read the complete live contract with deepline describe intercom_get_ticket --json.

Deepline cost

Pricing model: fixed (per call).
Estimated Deepline credits: 0 per pricing unit.
Provider-native pricing may still exist outside Deepline credit billing.

​Run this action

​CLI

​Example response

​Input reference

​Output reference

​Deepline cost

​Related documentation

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

Related documentation