Intercom: List Ticket States

List all ticket states.

Tool ID: intercom_list_ticket_states

Run this action

Use the TypeScript SDK for a single call. Put ctx.tools.execute(...) inside a Play when the call should be durable, scheduled, or run across a CSV.

import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'intercom_list_ticket_states',
  {},
);

console.log(result.toolResponse.raw);

CLI

deepline tools execute intercom_list_ticket_states --input '{}' --json

Example response

The SDK exposes this shape at result.toolResponse.raw. Values below are representative.

{
  "data": {
    "type": "example",
    "data": [
      {
        "type": "example",
        "id": "id_123",
        "category": "submitted"
      }
    ]
  }
}

Use deepline tools get intercom_list_ticket_states --json for the latest machine-readable contract.

Input reference

You can get a list of all ticket states for a workspace. This action does not require input fields.

Output reference

Standard tool result payload.

Name	Type	Required	Default	Details
`result.data`	`object`	Yes	—	A list of ticket states associated with a given ticket type.
`result.data.type`	`string`	No	—	String representing the object’s type. Always has the value `list`.
`result.data.data`	`array`	No	—	A list of ticket states associated with a given ticket type.
`result.data.data[].type`	`string`	No	—	String representing the object’s type. Always has the value `ticket_state`.
`result.data.data[].id`	`string`	No	—	The id of the ticket state
`result.data.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.data[].internal_label`	`string`	No	—	The state the ticket is currently in, in a human readable form - visible in Intercom
`result.data.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.data[].archived`	`boolean`	No	—	Whether the ticket state is archived
`result.data.data[].ticket_types`	`object`	No	—	A list of ticket types associated with a given ticket state.
`result.data.data[].ticket_types.type`	`string`	No	—	String representing the object’s type. Always has the value `list`.
`result.data.data[].ticket_types.data`	`array`	No	—	A list of ticket type attributes associated with a given ticket type.
`result.data.data[].ticket_types.data[].type`	`string`	No	—	String representing the object’s type. Always has the value `ticket_type`.
`result.data.data[].ticket_types.data[].id`	`string`	No	—	The id representing the ticket type.
`result.data.data[].ticket_types.data[].category`	`"Customer" \| "Back-office" \| "Tracker"`	No	—	Category of the Ticket Type. Allowed: `Customer`, `Back-office`, `Tracker`.
`result.data.data[].ticket_types.data[].name`	`string`	No	—	The name of the ticket type
`result.data.data[].ticket_types.data[].description`	`string`	No	—	The description of the ticket type
`result.data.data[].ticket_types.data[].icon`	`string`	No	—	The icon of the ticket type
`result.data.data[].ticket_types.data[].workspace_id`	`string`	No	—	The id of the workspace that the ticket type belongs to.
`result.data.data[].ticket_types.data[].ticket_type_attributes`	`object`	No	—	A list of attributes associated with a given ticket type.
`result.data.data[].ticket_types.data[].ticket_type_attributes.type`	`string`	No	—	String representing the object’s type. Always has the value `ticket_type_attributes.list`.
`result.data.data[].ticket_types.data[].ticket_type_attributes.ticket_type_attributes`	`array`	No	—	A list of ticket type attributes associated with a given ticket type.
`result.data.data[].ticket_types.data[].ticket_type_attributes.ticket_type_attributes[].type`	`string`	No	—	String representing the object’s type. Always has the value `ticket_type_attribute`.
`result.data.data[].ticket_types.data[].ticket_type_attributes.ticket_type_attributes[].id`	`string`	No	—	The id representing the ticket type attribute.
`result.data.data[].ticket_types.data[].ticket_type_attributes.ticket_type_attributes[].workspace_id`	`string`	No	—	The id of the workspace that the ticket type attribute belongs to.
`result.data.data[].ticket_types.data[].ticket_type_attributes.ticket_type_attributes[].name`	`string`	No	—	The name of the ticket type attribute
`result.data.data[].ticket_types.data[].ticket_type_attributes.ticket_type_attributes[].description`	`string`	No	—	The description of the ticket type attribute
`result.data.data[].ticket_types.data[].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.data[].ticket_types.data[].ticket_type_attributes.ticket_type_attributes[].input_options`	`record`	No	—	Input options for the attribute
`result.data.data[].ticket_types.data[].ticket_type_attributes.ticket_type_attributes[].order`	`integer`	No	—	The order of the attribute against other attributes
`result.data.data[].ticket_types.data[].ticket_type_attributes.ticket_type_attributes[].required_to_create`	`boolean`	No	`false`	Whether the attribute is required or not for teammates.
`result.data.data[].ticket_types.data[].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.data[].ticket_types.data[].ticket_type_attributes.ticket_type_attributes[].visible_on_create`	`boolean`	No	`true`	Whether the attribute is visible or not to teammates.
`result.data.data[].ticket_types.data[].ticket_type_attributes.ticket_type_attributes[].visible_to_contacts`	`boolean`	No	`true`	Whether the attribute is visible or not to contacts.
`result.data.data[].ticket_types.data[].ticket_type_attributes.ticket_type_attributes[].default`	`boolean`	No	—	Whether the attribute is built in or not.
`result.data.data[].ticket_types.data[].ticket_type_attributes.ticket_type_attributes[].ticket_type_id`	`integer`	No	—	The id of the ticket type that the attribute belongs to.
`result.data.data[].ticket_types.data[].ticket_type_attributes.ticket_type_attributes[].archived`	`boolean`	No	—	Whether the ticket type attribute is archived or not.
`result.data.data[].ticket_types.data[].ticket_type_attributes.ticket_type_attributes[].created_at`	`integer`	No	—	The date and time the ticket type attribute was created. Format: `timestamp`.
`result.data.data[].ticket_types.data[].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.data[].ticket_types.data[].ticket_states`	`object`	No	—	A list of ticket states associated with a given ticket type.
`result.data.data[].ticket_types.data[].ticket_states.type`	`string`	No	—	String representing the object’s type. Always has the value `list`.
`result.data.data[].ticket_types.data[].ticket_states.data`	`array`	No	—	A list of ticket states associated with a given ticket type.
`result.data.data[].ticket_types.data[].ticket_states.data[].type`	`string`	No	—	String representing the object’s type. Always has the value `ticket_state`.
`result.data.data[].ticket_types.data[].ticket_states.data[].id`	`string`	No	—	The id of the ticket state
`result.data.data[].ticket_types.data[].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.data[].ticket_types.data[].ticket_states.data[].internal_label`	`string`	No	—	The state the ticket is currently in, in a human readable form - visible in Intercom
`result.data.data[].ticket_types.data[].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.data[].ticket_types.data[].archived`	`boolean`	No	—	Whether the ticket type is archived or not.
`result.data.data[].ticket_types.data[].created_at`	`integer`	No	—	The date and time the ticket type was created. Format: `timestamp`.
`result.data.data[].ticket_types.data[].updated_at`	`integer`	No	—	The date and time the ticket type was last updated. Format: `timestamp`.

The table shows the first 50 fields. Expand the raw schema below for every field.

This output schema is too large to embed without slowing the page. Get the complete live contract with deepline tools get intercom_list_ticket_states --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.

Get started

Build and automate

Common workflows

Data and integrations

Reference

Intercom: List Ticket States

Run this action

CLI

Example response

Input reference

Output reference

Deepline cost

​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