Passer au contenu principal
GET
@firma-dev/sdk

Autorisations

Authorization
string
header
requis

Clé API pour l'authentification. Utilisez votre clé API directement sans préfixe (par exemple, 'your-api-key'). Le préfixe Bearer est optionnel mais pas obligatoire.

Paramètres de chemin

workspace_id
string<uuid>
requis

ID de l'espace de travail

id
string<uuid>
requis

ID du domaine

Réponse

Domaine récupéré avec succès

Configuration de domaine email pour l'envoi des emails de Demande de Signature

id
string<uuid>
requis

Identifiant unique du domaine

domain
string
requis

Le nom de domaine (par exemple, 'example.com')

verification_status
enum<integer>
requis

Statut de vérification de propriété du domaine : 0=en attente, 1=propriété vérifiée (enregistrement TXT confirmé), 2=finalisé (enregistré chez le fournisseur email)

Options disponibles:
0,
1,
2
domain_status
enum<integer>
requis

Statut d'envoi d'emails : 0=enregistrements DNS en attente de vérification, 1=entièrement vérifié et prêt à envoyer

Options disponibles:
0,
1
is_primary
boolean

Indique si c'est le domaine principal pour l'envoi d'emails depuis cet Espace de Travail

verification_token
string

Jeton à ajouter comme enregistrement TXT pour la vérification de propriété du domaine. Retourné uniquement quand verification_status=0.

resend_domain_id
string | null

ID de domaine du fournisseur email externe (usage interne)

dns_records
object[] | null

Enregistrements DNS requis pour l'envoi d'emails. Retourné uniquement après la finalisation du domaine (verification_status=2).

date_created
string<date-time>

Horodatage de création du domaine

date_changed
string<date-time>

Horodatage de dernière mise à jour du domaine