Intercom API (unofficial showcase)
POST/tickets/search

Search tickets

Searches tickets using filters on ticket attributes and other searchable fields. Supply a query to define a single filter or combine filters, and use pagination to control page size and continue through results. Filter values must match the type of the field being searched.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 2 body fields
Intercom-Versionstringoptional
The Intercom API version to use. Defaults to 2.17 when omitted.
Allowed:1.01.11.21.31.42.02.12.22.32.42.52.6Default:2.17

Ticket search criteria and optional cursor-based pagination settings.

queryobjectrequired
A single filter or a group of filters defining the ticket search; filter values and operators must be compatible with each field's type.
paginationobjectoptional
Cursor-based pagination settings for the search results.

1 status code
200Returns a list of matching ticket objects, the total result count, and cursor-based pagination details.
typestringoptional
Always ticket.list
Allowed:ticket.list
ticketsarray<Ticket>optional
The list of ticket objects
total_countintegeroptional
A count of the total number of objects.
pagesobjectoptional
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.

Error handling

The query body field is required. Search filters can be nested at most two levels deep, with no more than 15 filters in each AND or OR group; filter values and operators must match the searched field's type.