Skip to main content

Get Support Tenant Settings

GET 
/api/support/admin/tenants/:tenant/settings

Returns the support settings for one tenant: the default watchers (members added to every new ticket the tenant raises), the SLA policy override, and the agent notes. A tenant that has never been configured returns an empty watcher list and null for the override and notes.

Required scope: support:read

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

Response fields

  • tenant_id (string) — the tenant id.
  • tenant_name (string) — the tenant name, falling back to the id.
  • default_watcher_user_ids (integer[]) — the default watchers' user ids, de-duplicated.
  • default_watchers[] (object[]) — the same users expanded: id (integer), name (string, nullable), email (string), ordered by name.
  • sla_policy_id (integer, nullable) — the SLA policy override, or null to use the default policy.
  • notes (string, nullable) — free-text notes shown to agents working this tenant's tickets.

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