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, status and priority (by the words the customer sees — waiting, high; three letters or more), 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, 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>.

work — how far along the ticket is, in customer wording (null only on a ticket raised before work tracking existed). It never says who works the ticket — the support team is always "SKU.io Support":

  • picked_up_at (ISO-8601, nullable) — when SKU.io Support first picked the ticket up
  • stage (string) — one of: received, investigating, fixing, waiting_on_you, resolved (a ticket SKU.io Support has started on reads investigating — the customer is never told it was picked up, or by whom); stage_label (string) — Received, Picked up, Investigating, Working on a fix, Waiting on you, Resolved
  • working_now (boolean) and active_until (ISO-8601, nullable) — SKU.io Support is actively working the ticket right now
  • progress_text (string, nullable) and progress_at (ISO-8601, nullable) — the latest progress update

Who works the ticket, the internal working phase, the stale flag and approval cards are never part of the customer view.

category — what the ticket is about and why it was raised:

  • feature_key (string, nullable) — a key from the categories list (a SKU.io feature, platform.other or none); null while uncategorised. feature_label is its display name
  • area / area_label (string, nullable) — the product area of that feature (null for none or while uncategorised)
  • cause (string, nullable) — one of: how_to, configuration, defect, third_party, request, billing, data_process, other. cause_label is its display name
  • source (string, nullable) — who set it: ai (suggested automatically when the ticket was triaged), customer (someone on the account) or agent (SKU.io Support); source_label is the same in customer wording
  • suspected_defect (boolean) — an automatic check suspected a bug that nobody has confirmed yet. It is never counted as a defect; only SKU.io Support (or an engineering link) makes a ticket a defect
  • locked (boolean) — true once SKU.io Support set the category; the customer can no longer change it
  • set_at (ISO-8601, nullable) — when it was last set

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