Get custom domain status
Reads the workspace custom domain and checks its live ownership plus DNS/TLS configuration. ready becomes true only when ownership is verified and the platform reports a valid configuration that can receive a TLS certificate. Required scope: settings:read or assistants:read. Requires workspace owner/admin role and the Whitelabel entitlement. Requires the white-label entitlement (plan add-on whitelabel, or a workspace override). Workspaces without it get 403 whitelabel_not_in_plan, and only workspace owners and admins may call it.
Authorizations
API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, settings:write, platform:read, platform:write; a *:write scope implies the matching *:read. Automation and dashboard endpoints also accept the legacy calls:* scope. Keys without scope restrictions have full access.
Response
Live custom-domain status and any DNS records still required.