Skip to main content
GET
Read one authorized workspace sending domain

Authorizations

Authorization
string
header
required

WorkOS access JWT or a user-owned WorkOS API key. User keys are bound to one organization and restricted to their enabled product permissions. Session-only onboarding and session revocation require an interactive access JWT. No cookie session is assumed.

Headers

X-Request-Id
string

Optional caller-provided correlation identifier.

Required string length: 1 - 128

Path Parameters

organization_id
string
required
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
mail_domain_id
string
required
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$

Response

Authorized exact resource result.

domain_id
string
required
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
organization_id
string
required
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
domain
string
required
Required string length: 4 - 253
Pattern: ^(?=.{1,253}$)(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+[a-z]{2,63}$
registrable_domain
string
required
Required string length: 4 - 253
Pattern: ^(?=.{1,253}$)(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+[a-z]{2,63}$
revision
integer
required
Required range: x >= 1
status
enum<string>
required
Available options:
active,
retiring,
retired
sending
enum<string>
required
Available options:
disabled,
pending,
ready,
failed
receiving
enum<string>
required
Available options:
disabled,
pending,
ready,
failed
configured_at
string<date-time>
required
observed_at
string<date-time> | null
required
dns_records
object[]
required
bindings_count
integer
required
Required range: x >= 0