Skip to main content

Search Users

GET 
/api/support/agent/users

Finds SKU.io users by name or email fragment, with the tenants each one belongs to — the lookup behind linking a ticket's requester to their account (Link Ticket Requester to User). Deleted users are left out. Results are sorted by name; no pagination.

Required scope: support:read

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

Query parameters

  • search (string, required, 2–120 characters) — matched anywhere in the user's name or email
  • per_page (integer, optional, 1–25) — how many users to return. Default 10.

Response fields (each entry in data[])

  • id (integer) — the user id to send as user_id
  • name (string, nullable), email (string, nullable)
  • tenants[] — {id, name} for every tenant the user belongs to

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