Skip to main content
GET
Read project sender settings

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

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

Response

Authorized exact resource result.

mail_domain_id
string
required
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
organization_id
string
required
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
project_id
string
required
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
environment_id
string
required
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
revision
integer
required
Required range: x >= 1
sending
boolean
required
sender_addresses
string[]
required
Maximum array length: 32
Required string length: 3 - 254
default_from
string | null
required
Required string length: 3 - 254
default_reply_to
string | null
required
Required string length: 3 - 254
legacy
boolean
required
status
enum<string>
required
Available options:
active,
detached,
suspended
application_domain_identity
object | null
required