Skip to main content
Using TypeScript? Check out our GraphQL SDK for a fully typed client.
We provide a number of methods for fetching threads:
  1. Get a thread by ID
  2. Get a thread by external ID
  3. List threads — paginated, with filters
  4. Search threads — full-text search on title, description and message contents
All of these endpoints require the following permissions:
  • thread:read

Get a thread by ID

Query
Variables

Get a thread by external ID

A thread’s externalId is unique within a customer, which is why the customer ID is required when looking up by external ID.
Query
Variables

List threads

The threads query supports rich filtering (status, status detail, assignee, customer, labels, priority, date ranges) and sorting. This is the right query for building inbox-style views.
Query
Variables

Search threads

searchThreads performs a full-text search across thread title, description and message contents. For exact lookups prefer thread or threadByExternalId.
Query
Variables