Skip to main content
GET
List Tickets

Authorizations

Authorization
string
header
required

OAuth Bearer access tokens or Flow API keys with the required Flow scope families for the route.

Query Parameters

cursor
string

Opaque cursor for list pagination.

limit
integer

Requested page size for list operations.

Required range: 1 <= x <= 100
q
string

Optional conversation search text. Matches ticket key, title, and description as a case-insensitive substring. Matches requester display names as a case-insensitive word prefix. Matches active external provider ticket numbers as a case-insensitive substring.

team_id
string

Filter tickets by team scope.

team_ids
string<uuid>[]

Filter tickets by one or more owning-team IDs.

status_kinds
enum<string>[]

Filter tickets by one or more ticket status kinds.

Available options:
open,
pending,
on_hold,
resolved,
closed,
canceled
priority_kinds
enum<string>[]

Filter tickets by one or more ticket priority kinds.

Available options:
low,
normal,
high,
urgent
requester_principal_ids
string<uuid>[]

Filter tickets by one or more requester principal IDs.

assignee_principal_ids
string<uuid>[]

Filter tickets by one or more assignee principal IDs.

assignee_unassigned
boolean

When true, includes tickets with no assignee. Tickets assigned to Flow are not included. Can be combined with assignee_principal_ids and assignee_flow.

assignee_flow
boolean

When true, includes tickets assigned to the canonical Flow actor in the assignee facet filter. Can be combined with assignee_principal_ids and assignee_unassigned.

sync_provider_system_kinds
enum<string>[]

Filter tickets by displayed primary sync provider (oldest qualifying active sync link). Combined with sync_provider_flow_native as an OR.

Available options:
jira_service_management,
servicenow
sync_provider_flow_native
boolean

When true, includes tickets with no qualifying sync link (Flow-native conversations). Can be combined with sync_provider_system_kinds.

assignment_scope
enum<string>

Filter tickets by assignment queue relative to the authenticated operator: 'mine' (assigned to you), 'unassigned' (no assignee), or 'team' (assigned to another human). Combined with org-wide visibility scoping. When this parameter is set and both sort_field and sort_desc are omitted, results are ordered highest priority first, then newest updated_at.

Available options:
mine,
unassigned,
team
active_only
boolean

When true, excludes terminal-status tickets (resolved, closed, canceled) from the result set.

sort_field
enum<string>

Server-side ticket list sort field. Omit both this and sort_desc to use the endpoint default: with assignment_scope, highest priority then newest updated_at; otherwise newest updated_at. The assignment-scope default is not a sort_field enum value.

Available options:
key,
updated_at,
status_kind,
priority_kind
sort_desc
boolean

When true, sorts the selected ticket list field descending. Defaults to true for the endpoint default ordering and false when sort_field is explicitly provided without sort_desc. Sending sort_desc without sort_field selects updated_at order and opts out of the assignment-scope priority-first default.

group_field
enum<string>

Return group summaries with full counts. Set group_key to return rows in one group.

Available options:
status_kind,
priority_kind,
assignee,
sync_provider_system_kind
group_key
string

Canonical JSON string or null from a group summary key. Requires group_field.

group_cursor
string

Opaque next cursor for group summaries. Cannot be combined with group_key or cursor.

Response

Paginated ticket collection response.

data
object[]
required
page
object
required
meta
object
required
groups
object[]