API

Een domein ophalen

Voegt de adressen toe die erop bestaan, en of elk ervan is ingeschakeld.

GETapi.openemail.uk/domains/{id}

Voert de echte aanroep uit op je workspace, met je eigen sleutel.

GET /domains/{id}

Voegt de adressen toe die erop bestaan, en of elk ervan is ingeschakeld.

Voorbeeld

Vereist domains:read.

curl

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

Antwoord

{  "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"}

Een uitgeschakeld adres is niet langer bezorgbaar. Post ernaartoe wordt tijdens SMTP geweigerd, dus de afzender krijgt een bounce in plaats van stilte.

Wat je hier nog niet kunt

Nog niet uitgebracht

De schrijfacties die deze resource aanneemt zijn het eigen tracking-domein en het eigen bestandsdomein, allebei via PATCH /domains/{id}. De rest van de instelling van een domein kan voorlopig alleen in de app.

Een domein toevoegen en de te publiceren DNS-records uitlezen. GET meldt dat een domein niet geverifieerd is, maar niet welk record ontbreekt.
Een hercontrole van receiving of sending starten. Geen van beide heeft een endpoint, en geen van beide heeft er een nodig: een controle per uur hercontroleert elk niet-geverifieerd domein vanzelf, dus de records publiceren en laten staan is het hele werk. Abonneer je op domain.verified en domain.sending_changed in plaats van GET /domains te pollen, dan hoor je het zodra een van beide verandert. PATCH /domains/{id} controleert alleen het tracking-domein en het bestandsdomein.
Een adres aanmaken, uitschakelen of routeren. DELEN kan wel, want POST /members/{userId}/addresses geeft een bestaand adres aan iemand op member- of viewer-niveau. Het is het tot stand brengen van het adres wat deze resource niet kan.

Dit alles bestaat in de app onder Settings → Domains. Het is het API-oppervlak dat ontbreekt, niet de functionaliteit.