Skip to main content

List Support Tickets

GET 
/api/support/tickets

Lists the support tickets visible to the current user for the active tenant: org-wide tickets, plus any requester-only ticket they raised or were added to as a participant. Resolved and closed tickets are excluded by default — pass filter[include_closed]=1, a filter[status] value, a status condition in filter_groups, or the closed queue to see them.

Required scope: support:read

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

Each ticket carries its SLA state: first_response_sla_status and resolution_sla_status report the ticket's two SLA clocks: one of on_track, breaching_soon (past the policy's warning point, by default 75% of the way from creation to the due date), breached, paused (the ticket is waiting on the customer, so neither clock warns), met (responded / resolved before the due date). merged_into is {id, number} once the ticket has been merged into another, otherwise null.

Filtering: filter[search] matches the ticket number, subject, requester name and email, tags and the public message thread at once — internal notes are never searched; search_columns narrows it to named fields and search_strict_columns makes those fields match exactly. filter[status], filter[priority] and filter[type] each take one value or a comma-separated list, with all meaning no filter. filter[queue] picks a preset view: all, mine, watching or closed. Every other column is filtered with an operator suffix — filter[<column>.<operator>], e.g. filter[subject.starts_with]=Inventory. filter_groups expresses AND/OR and nested combinations. An unrecognised filter name or operator is rejected with 400.

Sorting: sort accepts id, subject, status, type, priority, requester_name, assignee_name, first_response_due_at, resolution_due_at, created_at and updated_at, prefixed with - for descending. The default is -updated_at, and the ticket number descending always breaks ties so paging cannot repeat or skip a row. Sorting by priority uses the urgency order low, medium, high, urgent rather than alphabetical order. Any other sort field is rejected with 400.

Pagination: standard pagination envelope — data plus current_page, last_page, per_page, total, from, to and the page links. per_page defaults to 10 and is capped at 100.

Original flat contract: the top-level status, priority, type, scope, include_closed, search and sort + direction parameters still work unchanged and may be mixed with the parameters above. sort=<column>&direction=desc means the same as sort=-<column>.

Authentication: Bearer token with the support:read scope, or an authenticated session. Requires the X-Tenant-Id header (or a tenant subdomain).

Request​

Responses​

OK

Response Headers
    Content-Type