> ## 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 Search Tickets: Inputs, Cost & CLI Example
> Search tickets. Intercom Intercom Search Tickets docs include request fields, response shape, pricing notes, and Deepline CLI examples.
## Run in Enrichment Spreadsheet
Use this function as a column step in `deepline enrich`.
```bash theme={null}
deepline enrich --input leads.csv --output leads.enriched.csv --with 'result=intercom_search_tickets:{"query":{}}' --json
```
Map payload values to spreadsheet columns with `{{column_name}}` placeholders.
## Input Schema
| Name | Type | Required | Default | Description |
| -------------------- | -------- | -------- | ------- | ----------- |
| `payload.query` | `object` | Yes | | |
| `payload.pagination` | `object` | No | | |
Show raw input schema
### Input JSON Schema
```json theme={null}
{
"type": "object",
"description": "Search using Intercoms Search APIs.",
"properties": {
"query": {
"type": "object",
"additionalProperties": true
},
"pagination": {
"type": [
"object",
"null"
],
"properties": {
"per_page": {
"type": "integer",
"description": "The number of results to fetch per page."
},
"starting_after": {
"type": [
"string",
"null"
],
"description": "The cursor to use in the next request to get the next page of results."
}
},
"additionalProperties": false
}
},
"required": [
"query"
],
"additionalProperties": false
}
```
## Output Schema
| Name | Type | Required | Default | Description |
| ------------- | -------- | -------- | ------- | --------------------------------------------------- |
| `result.data` | `object` | Yes | | Tickets are how you track requests from your users. |
| `result.meta` | `object` | No | | Additional response metadata (status, paging). |
Show raw output schema
### Output JSON Schema
```json theme={null}
{
"type": "object",
"description": "Standard tool result payload.",
"properties": {
"data": {
"type": "object",
"description": "Tickets are how you track requests from your users.",
"properties": {
"type": {
"type": "string",
"description": "Always ticket.list",
"enum": [
"ticket.list"
]
},
"tickets": {
"type": "array",
"description": "The list of ticket objects",
"items": {
"type": [
"object",
"null"
],
"description": "Tickets are how you track requests from your users.",
"properties": {
"type": {
"type": "string",
"description": "Always ticket",
"default": "ticket",
"enum": [
"ticket"
]
},
"id": {
"type": "string",
"description": "The unique identifier for the ticket which is given by Intercom."
},
"ticket_id": {
"type": "string",
"description": "The ID of the Ticket used in the Intercom Inbox and Messenger. Do not use ticket_id for API queries."
},
"category": {
"type": "string",
"description": "Category of the Ticket.",
"enum": [
"Customer",
"Back-office",
"Tracker"
]
},
"ticket_attributes": {
"type": "object",
"description": "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_`.",
"additionalProperties": {
"anyOf": [
{
"type": [
"string",
"null"
]
},
{
"type": "number"
},
{
"type": "boolean"
},
{
"type": "array"
},
{
"type": "object",
"description": "The value describing a file upload set for a custom attribute",
"properties": {
"type": {
"type": "string"
},
"name": {
"type": "string",
"description": "The name of the file"
},
"url": {
"type": "string",
"description": "The url of the file. This is a temporary URL and will expire after 30 minutes."
},
"content_type": {
"type": "string",
"description": "The type of file"
},
"filesize": {
"type": "integer",
"description": "The size of the file in bytes"
},
"width": {
"type": "integer",
"description": "The width of the file in pixels, if applicable"
},
"height": {
"type": "integer",
"description": "The height of the file in pixels, if applicable"
}
},
"additionalProperties": false
}
]
}
},
"ticket_state": {
"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
},
"ticket_type": {
"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
},
"contacts": {
"type": "object",
"description": "The list of contacts affected by a ticket.",
"properties": {
"type": {
"type": "string",
"description": "always contact.list",
"enum": [
"contact.list"
]
},
"contacts": {
"type": "array",
"description": "The list of contacts affected by this ticket.",
"items": {
"type": "object",
"description": "reference to contact object",
"properties": {
"type": {
"type": "string",
"description": "always contact",
"enum": [
"contact"
]
},
"id": {
"type": "string",
"description": "The unique identifier for the contact which is given by Intercom."
},
"external_id": {
"type": [
"string",
"null"
],
"description": "The unique identifier for the contact which is provided by the Client."
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"admin_assignee_id": {
"type": "string",
"description": "The id representing the admin assigned to the ticket."
},
"team_assignee_id": {
"type": "string",
"description": "The id representing the team assigned to the ticket."
},
"created_at": {
"type": "integer",
"description": "The time the ticket was created as a UTC Unix timestamp.",
"format": "date-time"
},
"updated_at": {
"type": "integer",
"description": "The last time the ticket was updated as a UTC Unix timestamp.",
"format": "date-time"
},
"open": {
"type": "boolean",
"description": "Whether or not the ticket is open. If false, the ticket is closed."
},
"snoozed_until": {
"type": "integer",
"description": "The time the ticket will be snoozed until as a UTC Unix timestamp. If null, the ticket is not currently snoozed.",
"format": "date-time"
},
"linked_objects": {
"type": "object",
"description": "An object containing metadata about linked conversations and linked tickets. Up to 1000 can be returned.",
"properties": {
"type": {
"type": "string",
"description": "Always list.",
"enum": [
"list"
]
},
"total_count": {
"type": "integer",
"description": "The total number of linked objects."
},
"has_more": {
"type": "boolean",
"description": "Whether or not there are more linked objects than returned."
},
"data": {
"type": "array",
"description": "An array containing the linked conversations and linked tickets.",
"items": {
"type": "object",
"description": "A linked conversation or ticket.",
"properties": {
"type": {
"type": "string",
"description": "ticket or conversation",
"enum": [
"ticket",
"conversation"
]
},
"id": {
"type": "string",
"description": "The ID of the linked object"
},
"category": {
"type": [
"string",
"null"
],
"description": "Category of the Linked Ticket Object.",
"enum": [
"Customer",
"Back-office",
"Tracker",
null
]
}
},
"additionalProperties": false
}
}
},
"additionalProperties": false
},
"ticket_parts": {
"type": "object",
"description": "A list of Ticket Part objects for each note and event in the ticket. There is a limit of 500 parts.",
"properties": {
"type": {
"type": "string",
"enum": [
"ticket_part.list"
]
},
"ticket_parts": {
"type": "array",
"description": "A list of Ticket Part objects for each ticket. There is a limit of 500 parts.",
"items": {
"type": "object",
"description": "A Ticket Part represents a message in the ticket.",
"properties": {
"type": {
"type": "string",
"description": "Always ticket_part"
},
"id": {
"type": "string",
"description": "The id representing the ticket part."
},
"part_type": {
"type": "string",
"description": "The type of ticket part."
},
"body": {
"type": [
"string",
"null"
],
"description": "The message body, which may contain HTML."
},
"previous_ticket_state": {
"type": "string",
"description": "The previous state of the ticket.",
"enum": [
"submitted",
"in_progress",
"waiting_on_customer",
"resolved"
]
},
"ticket_state": {
"type": "string",
"description": "The state of the ticket.",
"enum": [
"submitted",
"in_progress",
"waiting_on_customer",
"resolved"
]
},
"created_at": {
"type": "integer",
"description": "The time the ticket part was created.",
"format": "date-time"
},
"updated_at": {
"type": "integer",
"description": "The last time the ticket part was updated.",
"format": "date-time"
},
"assigned_to": {
"type": "object",
"description": "reference to another object",
"properties": {
"type": {
"type": "string"
},
"id": {
"type": [
"string",
"null"
]
}
},
"additionalProperties": false
},
"author": {
"type": "object",
"description": "The author that wrote or triggered the part. Can be a bot, admin, team or user.",
"properties": {
"type": {
"type": "string",
"description": "The type of the author",
"enum": [
"admin",
"bot",
"team",
"user"
]
},
"id": {
"type": "string",
"description": "The id of the author"
},
"name": {
"type": [
"string",
"null"
],
"description": "The name of the author"
},
"email": {
"type": "string",
"description": "The email of the author",
"format": "email"
}
},
"additionalProperties": false
},
"attachments": {
"type": "array",
"description": "A list of attachments for the part.",
"items": {
"type": "object",
"description": "The file attached to a part",
"properties": {
"type": {
"type": "string",
"description": "The type of attachment"
},
"name": {
"type": "string",
"description": "The name of the attachment"
},
"url": {
"type": "string",
"description": "The URL of the attachment"
},
"content_type": {
"type": "string",
"description": "The content type of the attachment"
},
"filesize": {
"type": "integer",
"description": "The size of the attachment"
},
"width": {
"type": "integer",
"description": "The width of the attachment"
},
"height": {
"type": "integer",
"description": "The height of the attachment"
}
},
"additionalProperties": false
}
},
"external_id": {
"type": [
"string",
"null"
],
"description": "The external id of the ticket part"
},
"redacted": {
"type": "boolean",
"description": "Whether or not the ticket part has been redacted."
},
"app_package_code": {
"type": "string",
"description": "The app package code if this part was created via API. Note this field won't show if the part was not created via API."
},
"updated_attribute_data": {
"type": [
"object",
"null"
],
"description": "The updated attribute data of the ticket part. Only present for attribute update parts.",
"properties": {
"attribute": {
"type": "object",
"description": "Information about the attribute that was updated.",
"properties": {
"type": {
"type": "string",
"description": "The type of the object. Always 'attribute'.",
"enum": [
"attribute"
]
},
"id": {
"type": "string",
"description": "The unique identifier of the attribute."
},
"label": {
"type": "string",
"description": "The human-readable name of the attribute."
}
},
"required": [
"type",
"id",
"label"
],
"additionalProperties": false
},
"value": {
"type": "object",
"description": "The new value of the attribute.",
"properties": {
"type": {
"type": "string",
"description": "The type of the object. Always 'value'.",
"enum": [
"value"
]
},
"id": {
"type": "object",
"additionalProperties": true
},
"label": {
"type": "object",
"additionalProperties": true
}
},
"required": [
"type",
"id",
"label"
],
"additionalProperties": false
}
},
"required": [
"attribute",
"value"
],
"additionalProperties": false
}
},
"additionalProperties": false
}
},
"total_count": {
"type": "integer"
}
},
"additionalProperties": false
},
"is_shared": {
"type": "boolean",
"description": "Whether or not the ticket is shared with the customer."
}
},
"additionalProperties": false
}
},
"total_count": {
"type": "integer",
"description": "A count of the total number of objects."
},
"pages": {
"type": [
"object",
"null"
],
"description": "Cursor-based pagination is a technique used in the Intercom API to navigate through large amounts of data. A \"cursor\" or pointer is used to keep track of the current position in the result set, allowing the API to return the data in small chunks or \"pages\" as needed.",
"properties": {
"type": {
"type": "string",
"description": "the type of object `pages`.",
"enum": [
"pages"
]
},
"page": {
"type": "integer",
"description": "The current page"
},
"next": {
"type": [
"object",
"null"
],
"properties": {
"per_page": {
"type": "integer",
"description": "The number of results to fetch per page."
},
"starting_after": {
"type": [
"string",
"null"
],
"description": "The cursor to use in the next request to get the next page of results."
}
},
"additionalProperties": false
},
"per_page": {
"type": "integer",
"description": "Number of results per page"
},
"total_pages": {
"type": "integer",
"description": "Total number of pages"
}
},
"additionalProperties": false
}
},
"additionalProperties": false
},
"meta": {
"type": "object",
"description": "Additional response metadata (status, paging).",
"additionalProperties": true
}
},
"required": [
"data"
],
"additionalProperties": false
}
```
## Advanced: Direct CLI
Use direct execution for single payload debugging.
```bash theme={null}
deepline tools execute intercom_search_tickets --payload '{
"query": {}
}' --json
```
### CLI flags
| Flag | Description |
| --------------------------- | --------------------------------------------------- |
| `--json` | Print machine-readable output. |
| `--wait` | Wait for terminal provider status when supported. |
| `--debug` | Enable wait mode with additional status/log output. |
| `--wait-timeout SECONDS` | Max seconds to wait in wait mode. |
| `--poll-interval SECONDS` | Polling interval in seconds during wait mode. |
| `--timeout SECONDS` | Request timeout in seconds. |
| `--connect-timeout SECONDS` | Connection timeout in seconds. |
## Cost
* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.
* Billing mode: `no_bill`.