> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Intercom: Get Ticket Type

> Get an Intercom ticket type by its ID, with its attributes. Includes SDK V2 guidance, input constraints, response fields, and Deepline credit cost.

Get an Intercom ticket type by its ID, with its attributes.

> [!NOTE]
>
> Tool ID: `intercom_get_ticket_type`

## 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.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'intercom_get_ticket_type',
  {
    "ticket_type_id": "ticket_type_123"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute intercom_get_ticket_type --input '{
  "ticket_type_id": "ticket_type_123"
}' --json
```

## Example response

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

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "type": "example",
    "id": "id_123",
    "category": "Customer"
  }
}
```

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

## Input reference

You can fetch the details of a single ticket type.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.ticket_type_id` | `string` | Yes | — | The unique identifier for the ticket type which is given by Intercom. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "You can fetch the details of a single ticket type.",
    "properties": {
      "ticket_type_id": {
        "type": "string",
        "description": "The unique identifier for the ticket type which is given by Intercom."
      }
    },
    "required": [
      "ticket_type_id"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | A ticket type, used to define the data fields to be captured in a ticket. |
| `result.data.type` | `string` | No | — | String representing the object's type. Always has the value `ticket_type`. |
| `result.data.id` | `string` | No | — | The id representing the ticket type. |
| `result.data.category` | `"Customer" \| "Back-office" \| "Tracker"` | No | — | Category of the Ticket Type. Allowed: `Customer`, `Back-office`, `Tracker`. |
| `result.data.name` | `string` | No | — | The name of the ticket type |
| `result.data.description` | `string` | No | — | The description of the ticket type |
| `result.data.icon` | `string` | No | — | The icon of the ticket type |
| `result.data.workspace_id` | `string` | No | — | The id of the workspace that the ticket type belongs to. |
| `result.data.ticket_type_attributes` | `object` | No | — | A list of attributes associated with a given ticket type. |
| `result.data.ticket_type_attributes.type` | `string` | No | — | String representing the object's type. Always has the value `ticket_type_attributes.list`. |
| `result.data.ticket_type_attributes.ticket_type_attributes` | `array` | No | — | A list of ticket type attributes associated with a given ticket type. |
| `result.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.ticket_type_attributes.ticket_type_attributes[].id` | `string` | No | — | The id representing the ticket type attribute. |
| `result.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.ticket_type_attributes.ticket_type_attributes[].name` | `string` | No | — | The name of the ticket type attribute |
| `result.data.ticket_type_attributes.ticket_type_attributes[].description` | `string` | No | — | The description of the ticket type attribute |
| `result.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.ticket_type_attributes.ticket_type_attributes[].input_options` | `record` | No | — | Input options for the attribute |
| `result.data.ticket_type_attributes.ticket_type_attributes[].order` | `integer` | No | — | The order of the attribute against other attributes |
| `result.data.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_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_attributes.ticket_type_attributes[].visible_on_create` | `boolean` | No | `true` | Whether the attribute is visible or not to teammates. |
| `result.data.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_attributes.ticket_type_attributes[].default` | `boolean` | No | — | Whether the attribute is built in or not. |
| `result.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.ticket_type_attributes.ticket_type_attributes[].archived` | `boolean` | No | — | Whether the ticket type attribute is archived or not. |
| `result.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.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_states` | `object` | No | — | A list of ticket states associated with a given ticket type. |
| `result.data.ticket_states.type` | `string` | No | — | String representing the object's type. Always has the value `list`. |
| `result.data.ticket_states.data` | `array` | No | — | A list of ticket states associated with a given ticket type. |
| `result.data.ticket_states.data[].type` | `string` | No | — | String representing the object's type. Always has the value `ticket_state`. |
| `result.data.ticket_states.data[].id` | `string` | No | — | The id of the ticket state |
| `result.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.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_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.archived` | `boolean` | No | — | Whether the ticket type is archived or not. |
| `result.data.created_at` | `integer` | No | — | The date and time the ticket type was created. Format: `timestamp`. |
| `result.data.updated_at` | `integer` | No | — | The date and time the ticket type was last updated. Format: `timestamp`. |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": [
          "object",
          "null"
        ],
        "description": "A ticket type, used to define the data fields to be captured in a ticket.",
        "properties": {
          "type": {
            "type": "string",
            "description": "String representing the object's type. Always has the value `ticket_type`."
          },
          "id": {
            "type": "string",
            "description": "The id representing the ticket type."
          },
          "category": {
            "type": "string",
            "description": "Category of the Ticket Type.",
            "enum": [
              "Customer",
              "Back-office",
              "Tracker"
            ]
          },
          "name": {
            "type": "string",
            "description": "The name of the ticket type"
          },
          "description": {
            "type": "string",
            "description": "The description of the ticket type"
          },
          "icon": {
            "type": "string",
            "description": "The icon of the ticket type"
          },
          "workspace_id": {
            "type": "string",
            "description": "The id of the workspace that the ticket type belongs to."
          },
          "ticket_type_attributes": {
            "type": "object",
            "description": "A list of attributes associated with a given ticket type.",
            "properties": {
              "type": {
                "type": "string",
                "description": "String representing the object's type. Always has the value `ticket_type_attributes.list`."
              },
              "ticket_type_attributes": {
                "type": "array",
                "description": "A list of ticket type attributes associated with a given ticket type.",
                "items": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "description": "Ticket type attribute, used to define each data field to be captured in a ticket.",
                  "properties": {
                    "type": {
                      "type": "string",
                      "description": "String representing the object's type. Always has the value `ticket_type_attribute`."
                    },
                    "id": {
                      "type": "string",
                      "description": "The id representing the ticket type attribute."
                    },
                    "workspace_id": {
                      "type": "string",
                      "description": "The id of the workspace that the ticket type attribute belongs to."
                    },
                    "name": {
                      "type": "string",
                      "description": "The name of the ticket type attribute"
                    },
                    "description": {
                      "type": "string",
                      "description": "The description of the ticket type attribute"
                    },
                    "data_type": {
                      "type": "string",
                      "description": "The type of the data attribute (allowed values: \"string list integer decimal boolean datetime files\")"
                    },
                    "input_options": {
                      "type": "object",
                      "description": "Input options for the attribute"
                    },
                    "order": {
                      "type": "integer",
                      "description": "The order of the attribute against other attributes"
                    },
                    "required_to_create": {
                      "type": "boolean",
                      "description": "Whether the attribute is required or not for teammates.",
                      "default": false
                    },
                    "required_to_create_for_contacts": {
                      "type": "boolean",
                      "description": "Whether the attribute is required or not for contacts.",
                      "default": false
                    },
                    "visible_on_create": {
                      "type": "boolean",
                      "description": "Whether the attribute is visible or not to teammates.",
                      "default": true
                    },
                    "visible_to_contacts": {
                      "type": "boolean",
                      "description": "Whether the attribute is visible or not to contacts.",
                      "default": true
                    },
                    "default": {
                      "type": "boolean",
                      "description": "Whether the attribute is built in or not."
                    },
                    "ticket_type_id": {
                      "type": "integer",
                      "description": "The id of the ticket type that the attribute belongs to."
                    },
                    "archived": {
                      "type": "boolean",
                      "description": "Whether the ticket type attribute is archived or not."
                    },
                    "created_at": {
                      "type": "integer",
                      "description": "The date and time the ticket type attribute was created.",
                      "format": "timestamp"
                    },
                    "updated_at": {
                      "type": "integer",
                      "description": "The date and time the ticket type attribute was last updated.",
                      "format": "timestamp"
                    }
                  },
                  "additionalProperties": false
                }
              }
            },
            "additionalProperties": false
          },
          "ticket_states": {
            "type": "object",
            "description": "A list of ticket states associated with a given ticket type.",
            "properties": {
              "type": {
                "type": "string",
                "description": "String representing the object's type. Always has the value `list`."
              },
              "data": {
                "type": "array",
                "description": "A list of ticket states associated with a given ticket type.",
                "items": {
                  "type": [
                    "object",
                    "null"
                  ],
                  "description": "A ticket state, used to define the state of a ticket.",
                  "properties": {
                    "type": {
                      "type": "string",
                      "description": "String representing the object's type. Always has the value `ticket_state`."
                    },
                    "id": {
                      "type": "string",
                      "description": "The id of the ticket state"
                    },
                    "category": {
                      "type": "string",
                      "description": "The category of the ticket state",
                      "enum": [
                        "submitted",
                        "in_progress",
                        "waiting_on_customer",
                        "resolved"
                      ]
                    },
                    "internal_label": {
                      "type": "string",
                      "description": "The state the ticket is currently in, in a human readable form - visible in Intercom"
                    },
                    "external_label": {
                      "type": "string",
                      "description": "The state the ticket is currently in, in a human readable form - visible to customers, in the messenger, email and tickets portal."
                    }
                  },
                  "additionalProperties": false
                }
              }
            },
            "additionalProperties": false
          },
          "archived": {
            "type": "boolean",
            "description": "Whether the ticket type is archived or not."
          },
          "created_at": {
            "type": "integer",
            "description": "The date and time the ticket type was created.",
            "format": "timestamp"
          },
          "updated_at": {
            "type": "integer",
            "description": "The date and time the ticket type was last updated.",
            "format": "timestamp"
          }
        },
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

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

## Related documentation

* [Intercom provider guide](https://deepline.com/docs/providers/intercom/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.