Skip to main content

List Agent Directory

GET 
/api/support/agent/agents

Lists the support agents another agent can choose from — when assigning a ticket or @mentioning someone in an internal note. By default only active seats held by super-admin users who still exist are returned; pass include_inactive=1 to also get revoked seats, seats whose user is no longer a super admin, and seats whose user has been deleted from sku.io — all reported with is_active: false, since is_active here means the seat can actually be assigned work (active AND super admin AND not deleted). Entries are sorted by display name, case-insensitively. No pagination.

Required scope: support:read

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

Query parameters

  • include_inactive (boolean, optional) — 1 / true to include inactive seats. Default false.

Response fields (each entry in data[])

  • id (integer) — the support seat id (not the user id)
  • user_id (integer) — the agent's central user id; this is the value to send as assignee_user_id
  • name (string) — the agent's display name, else their user name, else their email
  • email (string, nullable)
  • role (string) — one of: admin, agent, viewer. A viewer reads tickets and leaves internal notes but cannot work tickets and cannot be assigned one.
  • is_active (boolean) — true only when the seat is active and its user is a super admin

Authentication: Bearer token with the support:read scope, or an authenticated session, from a caller with an active support role (any role, including viewer). No tenant context — this endpoint is central.

Request​

Responses​

OK

Response Headers
    Content-Type