API

Récupérer un domaine

Ajoute les adresses qui existent sur le domaine, et indique si chacune est activée.

GETapi.openemail.uk/domains/{id}

Exécute le véritable appel sur votre espace de travail, avec votre propre clé.

GET /domains/{id}

Ajoute les adresses qui existent sur le domaine, et indique si chacune est activée.

Exemple

Nécessite domains:read.

curl

curl "$OE/domains/b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f" -H "$AUTH"

Réponse

{  "object": "domain",  "id": "b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f",  "domain": "acme.com",  "receiving": {    "verified": true,    "verifiedAt": "2026-08-14T10:02:00.000Z",    "catchAll": false,    "lastCheckedAt": "2026-08-29T06:00:00.000Z",    "error": null  },  "sending": {    "status": "verified",    "canSend": true,    "checkedAt": "2026-08-29T06:00:00.000Z",    "error": null,    "note": "Mail from this domain is signed and can be sent."  },  "tracking": {    "host": "links.acme.com",    "status": "active",    "active": true,    "target": "oelinks3f9a1c7e2b8d4a60.edge.openemail.uk",    "record": { "type": "CNAME", "name": "links.acme.com", "value": "oelinks3f9a1c7e2b8d4a60.edge.openemail.uk" },    "checkedAt": "2026-08-29T06:10:00.000Z",    "verifiedAt": "2026-08-29T06:10:00.000Z",    "error": null  },  "storage": {    "host": "files.acme.com",    "status": "active",    "active": true,    "target": "oefiles81c40d6b2f7e9a35.edge.openemail.uk",    "record": { "type": "CNAME", "name": "files.acme.com", "value": "oefiles81c40d6b2f7e9a35.edge.openemail.uk" },    "checkedAt": "2026-08-29T06:10:00.000Z",    "verifiedAt": "2026-08-29T06:10:00.000Z",    "error": null  },  "addresses": [    { "address": "[email protected]", "enabled": true },    { "address": "[email protected]", "enabled": false }  ],  "createdAt": "2026-08-14T09:55:11.000Z"}

Une adresse désactivée cesse d'être distribuable. Les messages qui lui sont destinés sont refusés au moment du SMTP : l'expéditeur reçoit donc un rejet plutôt que du silence.

Ce que vous ne pouvez pas encore faire ici

Pas encore disponible

Les écritures que cette ressource accepte sont le domaine de suivi personnalisé et le domaine de fichiers personnalisé, tous deux via PATCH /domains/{id}. Le reste de la configuration d'un domaine passe uniquement par l'application pour l'instant.

Ajouter un domaine et lire les enregistrements DNS à publier. GET signale qu'un domaine n'est pas vérifié, mais pas quel enregistrement manque.
Déclencher une nouvelle vérification de receiving ou de sending. Ni l'un ni l'autre n'a d'endpoint, et aucun n'en a besoin : un balayage horaire revérifie de lui-même chaque domaine non vérifié, si bien que publier les enregistrements et les laisser en place constitue tout le travail. Abonnez-vous à domain.verified et à domain.sending_changed plutôt que d'interroger GET /domains en boucle, et vous serez prévenu dès que l'un ou l'autre bouge. PATCH /domains/{id} ne vérifie que le domaine de suivi et le domaine de fichiers.
Créer, désactiver ou router une adresse. Le PARTAGE, lui, existe : POST /members/{userId}/addresses confie une adresse existante à quelqu'un au niveau member ou viewer. C'est faire exister l'adresse que cette ressource ne sait pas faire.

Tout cela existe dans l'application, sous Paramètres → Domaines. C'est la surface d'API qui manque, pas la fonctionnalité.