Skip to main content
GET
/
workspace
/
{workspace_id}
/
domains
/
{id}
Get workspace domain
curl --request GET \
  --url https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/domains/{id} \
  --header 'Authorization: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "domain": "<string>",
  "verification_status": 0,
  "domain_status": 0,
  "is_primary": true,
  "verification_token": "<string>",
  "resend_domain_id": "<string>",
  "dns_records": [
    {
      "type": "TXT",
      "name": "<string>",
      "value": "<string>",
      "ttl": "<string>",
      "priority": 123,
      "status": "pending"
    }
  ],
  "date_created": "2023-11-07T05:31:56Z",
  "date_changed": "2023-11-07T05:31:56Z"
}

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>

Unique identifier for the domain

​
domain
string

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

​
verification_status
enum<integer>

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>

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