Skip to main content
GET
Search tickets

Authorizations

X-Initdesk-Token
string
header
required

Path Parameters

organization_id
string
required
Pattern: ^[-a-zA-Z0-9_]+$

Query Parameters

assignee
integer

Filter tickets assigned to the given organization user ID.

channel
string

Filter by conversation channel type (e.g. email).

classification
enum<string>

Filter tickets by close classification. Omit to include all classifications.

Available options:
,
customer_inactivity,
invalid,
no_response,
other,
resolved
company
string

Filter tickets whose requester currently belongs to this company (UUID). Membership is live, not denormalized on the search document. More than 10000 members → 400. Unknown company → 404. Malformed UUID → 400.

custom_preset_filter
string

Apply a saved custom preset filter by UUID. Integration tokens may only use organization-shared filters.

email
string

Filter by customer email (case-insensitive exact match).

is_snoozed
boolean

When omitted, no snooze constraint is applied. Pass true for tickets with an active snooze; false to exclude snoozed tickets. Accepted values: true, false (case-insensitive).

is_spam
boolean

When omitted defaults to false. Pass true to include only spam tickets. Accepted values: true, false (case-insensitive).

ordering
string

Sort field. When omitted with no text query, results are sorted by priority (most-urgent first), then relevance, then updated_at. When omitted with a text query, results are sorted by relevance, then updated_at. priority is most-urgent first (urgent down to not_set); -priority is the reverse. _score is best match first; -_score is worst match first. Other fields follow the usual minus-for-descending convention. Allowed fields: id, public_id, subject, description, status, priority, created_at, updated_at, _score.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

preset_filter
enum<string>

Apply a predefined filter. Allowed values: needs_attention, focused

Available options:
focused,
needs_attention
priority
enum<string>

Filter tickets by priority. not_set matches tickets that have not been triaged.

Available options:
high,
low,
medium,
not_set,
urgent
query
string

Text to search for. search is an alias.

tags
string[]

Filter by tag name (case-insensitive). Repeat the parameter to match tickets with any of the listed tags (e.g. ?tags=urgent&tags=vip).

waiting_on
enum<string>

Filter by waiting_on status.

Available options:
,
associate,
customer

Response

200 - application/json
count
integer
required
Example:

123

results
object[]
required
next
string<uri> | null
Example:

"http://api.example.org/accounts/?page=4"

previous
string<uri> | null
Example:

"http://api.example.org/accounts/?page=2"