Skip to main content

List Support Agents

GET 
/api/support/admin/agents

Lists every support seat — active and revoked — one page at a time, for the support settings. A seat is a central sku.io user with a support role; the role decides what they may do (admin reaches these settings endpoints, agent works tickets, viewer only reads and leaves internal notes). is_effective is what the access checks actually use: the seat is active AND the user is a super admin AND the user has not been deleted. is_deleted is true when the seat's user was removed from sku.io — the seat stays in this list (so a revoked or orphaned seat is never invisible) but grants nothing until that user is restored.

Required scope: support:read

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

Query parameters (all optional)

  • filter[search] (string) — case-insensitive match against the display name, the user's name, or the email.
  • filter[role] (string) — exact match; one of: admin, agent, viewer. A comma-separated list matches any of them.
  • filter[is_active] (boolean) — true/1 for active seats, false/0 for revoked seats. Omit for both.
  • filter[created_at] (date) — a single day YYYY-MM-DD, or an inclusive range YYYY-MM-DD,YYYY-MM-DD.
  • sort (string) — one field; prefix with - for descending. Allowed sorts: name (the effective display name — display name, else user name, else email), email, role, created_at. Default: name ascending.
  • per_page (integer) — page size. Default 10, maximum 100.
  • page (integer) — page number. Default 1.

An unknown filter[...] key or sort field is rejected with 400.

Response: standard Laravel paginator envelope; each row is a seat with id, user_id, name, user_name, email, display_name (nullable), signature (nullable), role, notifications (new_ticket, customer_reply, sla, mention — each a boolean, defaulting to true when never set), is_active, is_super_admin, is_effective, created_at, updated_at.

Authentication: Bearer token with the support:read scope, or an authenticated session, from a caller with an active support role who also holds the support admin role. No tenant context — this endpoint is central.

Request​

Responses​

OK

Response Headers
    Content-Type