Search Tickets

Search tickets

POST/tickets/search

Use it in a workflow

Add a step and choose the Intercom connector.
Pick the Search Tickets action (under Tickets).
Fill in the fields below, then reference the result from later steps as {{searchTickets.response.data}}.

Request

Headers

Intercom-Versionstring

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

One of1.01.11.21.31.42.02.12.22.32.42.52.62.72.82.92.102.112.122.132.142.152.16Default "2.16"

Request body

Enter the body as JSON in the step's Body field.

queryoneOfrequired

paginationobject

per_pageinteger

The number of results to fetch per page.

starting_afterstring

The cursor to use in the next request to get the next page of results.

json

{
  "query": null,
  "pagination": {
    "per_page": 2,
    "starting_after": "your-cursor-from-response"
  }
}

Response

Returns 200 with an object. Read it in later steps with {{searchTickets.response.data.<field>}}.

typestring

Always ticket.list

One ofticket.list

ticketsarray<object>

The list of ticket objects

typestring

Always ticket

One ofticketDefault "ticket"

idstring

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

ticket_idstring

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

categorystring

Category of the Ticket.

One ofCustomerBack-officeTracker

ticket_attributesobject

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_stateobject5 fields

A ticket state, used to define the state of a ticket.

ticket_typeobject12 fields

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

contactsobject2 fields

The list of contacts affected by a ticket.

admin_assignee_idinteger

The id representing the admin assigned to the ticket. If it's not assigned to an admin it will return 0.

team_assignee_idinteger

The id representing the team assigned to the ticket. If it's not assigned to a team it will return 0.

created_atinteger (date-time)

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

updated_atinteger (date-time)

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

openboolean

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

snoozed_untilinteger (date-time)

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

linked_objectsobject4 fields

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

ticket_partsobject3 fields

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

is_sharedboolean

Whether or not the ticket is shared with the customer.

previous_ticket_state_idstring

The ID of the previous ticket state from the most recent state change. Returns null if no state change history exists. Useful for tracking state transitions for reporting and compliance.

total_countinteger

A count of the total number of objects.

pagesobject

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.

typestring

the type of object `pages`.

One ofpages

pageinteger

The current page

nextobject2 fields

per_pageinteger

Number of results per page

total_pagesinteger

Total number of pages

json

{
  "type": "ticket.list",
  "tickets": [
    {
      "type": "ticket",
      "id": "1295",
      "ticket_id": "1390",
      "category": "Customer",
      "ticket_attributes": {
        "_default_title_": "Found a bug",
        "_default_description_": "The button's not working"
      },
      "ticket_state": {
        "type": "ticket_state",
        "id": "12",
        "category": "in_progress",
        "internal_label": "With Dev Team",
        "external_label": "In Progress"
      },
      "ticket_type": {
        "type": "ticket_type",
        "id": "1295",
        "category": "Customer",
        "name": "Bug",
        "description": "A bug that has been reported.",
        "icon": "🐞",
        "workspace_id": "ecahpwf5",
        "ticket_type_attributes": {
          "type": "string",
          "ticket_type_attributes": [
            {
              "type": null,
              "id": null,
              "workspace_id": null,
              "name": null,
              "description": null,
              "data_type": null,
              "input_options": null,
              "order": null,
              "required_to_create": null,
              "required_to_create_for_contacts": null,
              "visible_on_create": null,
              "visible_to_contacts": null
            }
          ]
        },
        "ticket_states": {
          "type": "list",
          "data": [
            {
              "type": null,
              "id": null,
              "category": null,
              "internal_label": null,
              "external_label": null
            }
          ]
        },
        "archived": false,
        "created_at": 0,
        "updated_at": 0
      },
      "contacts": {
        "type": "contact.list",
        "contacts": [
          {
            "type": "contact",
            "id": "5ba682d23d7cf92bef87bfd4",
            "external_id": "70"
          }
        ]
      },
      "admin_assignee_id": 1295,
      "team_assignee_id": 1295,
      "created_at": 1663597223,
      "updated_at": 1663597260
    }
  ],
  "total_count": 12345,
  "pages": {
    "type": "pages",
    "page": 1,
    "next": {
      "per_page": 2,
      "starting_after": "your-cursor-from-response"
    },
    "per_page": 2,
    "total_pages": 13
  }
}

Need more? See the Intercom guide for connection setup and behaviour shared by every action.

Was this page helpful?