Skip to main content

List Support Tenants

GET 
/api/support/admin/tenants

Lists every tenant (customer account) with its open-ticket count and a summary of its support settings — the SLA policy override, the default watchers, and agent notes. Use this to find a tenant before reading or updating its settings.

Required scope: support:read

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

Query parameters

  • filter[search] (string, optional) — matches the tenant id, the tenant name, or any of its domains (partial match).
  • filter[sla_policy_id] (integer or comma-separated list, optional) — only tenants whose SLA override is one of the given policy ids.
  • filter[has_default_watchers] (boolean, optional) — true returns tenants with at least one default watcher, false tenants with none.
  • sort (string, optional) — prefix with - for descending. Allowed sorts: name, open_tickets. Default: tenant id ascending.
  • per_page (integer, optional) — items per page. Default 10, maximum 100.
  • page (integer, optional) — page number. Default 1.

Response rows

  • id (string) — the tenant id.
  • name (string) — the tenant name, falling back to the id.
  • domain (string, nullable) — the tenant's primary domain (a *.sku.io domain when it has one).
  • home_pod_host (string, nullable) — the regional host the tenant is served from, or null when it is served centrally.
  • open_tickets (integer) — tickets that are not resolved or closed.
  • sla_policy_id (integer, nullable) — the SLA policy override, or null to use the default policy.
  • default_watcher_user_ids (integer[]) — tenant members added as watchers on every new ticket.
  • notes (string, nullable) — free-text notes for agents.

Pagination: standard Laravel pagination envelope (current_page, data, last_page, per_page, total, ...).

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