Skip to main content
GET
@firma-dev/sdk

Authorizations

Authorization
string
header
required

API key for authentication. Use your API key directly without any prefix (e.g., 'your-api-key'). Bearer prefix is optional but not required.

Path Parameters

workspace_id
string<uuid>
required

Workspace ID

id
string<uuid>
required

Domain ID

Response

Domain retrieved successfully

Email domain configuration for sending signing request emails

id
string<uuid>
required

Unique identifier for the domain

domain
string
required

The domain name (e.g., 'example.com')

verification_status
enum<integer>
required

Domain ownership verification status: 0=pending, 1=ownership verified (TXT record confirmed), 2=finalized (registered with email provider)

Available options:
0,
1,
2
domain_status
enum<integer>
required

Email sending status: 0=DNS records pending verification, 1=fully verified and ready to send

Available options:
0,
1
is_primary
boolean

Whether this is the primary domain for sending emails from this workspace

verification_token
string

Token to add as TXT record for domain ownership verification. Only returned when verification_status=0.

resend_domain_id
string | null

External email provider domain ID (internal use)

dns_records
object[] | null

Required DNS records for email sending. Only returned after domain finalization (verification_status=2).

date_created
string<date-time>

Domain creation timestamp

date_changed
string<date-time>

Domain last update timestamp