Email Domains

Get company domain

Retrieve details of a specific company domain including verification status and DNS records

get/company/domains/{id}

Request

Base URL
https://api.firma.dev/functions/v1/signing-request-api
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/firma/apis/firma-partner-api/docs/company/domains/:id/get.ts
A function with typed inputs. Its response is checked against the schema.

idstring uuid required

Domain ID

Domain retrieved successfully

idstring uuid required

Unique identifier for the domain

domainstring required

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

verification_status0 | 1 | 2 required

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

domain_status0 | 1 required

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

is_primaryboolean

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

verification_tokenstring

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

resend_domain_idstring nullable

External email provider domain ID (internal use)

date_createdstring date-time

Domain creation timestamp

date_changedstring date-time

Domain last update timestamp

No recorded changes to this operation across all 13 revisions of this API.