Ir a la documentación
API

Recuperar la dirección de la app web

La dirección de la app web del espacio de trabajo, si se puede iniciar sesión allí, y el registro CNAME que necesita. Si no hay ninguna configurada, `status` es `none` y `domains` lista los dominios bajo los que puede ir una.

GET/app-host

Ejecuta la llamada real en tu espacio de trabajo.

GET /app-host

La dirección de la app web del espacio de trabajo, si se puede iniciar sesión allí, y el registro CNAME que necesita. Si no hay ninguna configurada, status es none y domains lista los dominios bajo los que puede ir una.

Qué es la dirección de la app web

shell
export OE=https://api.openemail.ukexport AUTH="Authorization: Bearer $OPENEMAIL_API_KEY"

Un espacio de trabajo con un plan de pago puede abrir la app web en un subdominio de uno de sus dominios verificados, como mailbox.acme.com, además de en openemail.uk. Es la dirección que establece la pestaña App con tu marca en la configuración de Apariencia del espacio de trabajo, y un espacio de trabajo tiene como máximo una.

Solo pueden iniciar sesión allí los miembros del espacio de trabajo, las personas que inician sesión con una de sus direcciones y cualquiera con una invitación pendiente, y solo ellos reciben desde allí los correos de restablecimiento de contraseña y de verificación. Se ve como openemail.uk hasta que el espacio de trabajo pone un logo en su página de Apariencia, y entonces muestra el logo, el símbolo y el nombre del espacio de trabajo en lugar de los nuestros. A partir de entonces, los correos que OpenEmail les envía llevan la marca, enlazan de vuelta a la dirección y llegan desde noreply@ su dominio una vez verificados los registros de firma de ese dominio.

Necesita un registro CNAME, que record detalla. La dirección queda en pending hasta que el registro responda y se emita su certificado, y después pasa a active. En el plan gratuito se conserva pero queda en pausa: paused es true y nadie puede iniciar sesión allí hasta que el espacio de trabajo vuelva a tener un plan de pago.

Ejemplo

Requiere domains:read.

curl
curl "$OE/app-host" -H "$AUTH"
Respuesta
{  "object": "app_host",  "id": "ahost_3f9c2a71d0b84e56a1c7f2e9",  "host": "mailbox.acme.com",  "domainId": "b3e1f0a4-6c2d-4e8a-9f17-2d5c8a0b4e6f",  "domain": "acme.com",  "status": "active",  "active": true,  "paused": false,  "target": "cname.openemail.uk",  "record": {    "type": "CNAME",    "name": "mailbox.acme.com",    "value": "cname.openemail.uk"  },  "error": null,  "checkedAt": "2026-10-01T09:12:30.000Z",  "verifiedAt": "2026-10-01T09:04:11.000Z",  "available": true,  "paidPlan": true,  "domains": ["acme.com"],  "suggested": "mailbox.acme.com"}

Leer la dirección la vuelve a comprobar cuando su última comprobación tiene más de 15 segundos, así que consultar esta ruta periódicamente es la forma de esperar a que active pase a true.

active es true solo cuando status es active y el espacio de trabajo tiene un plan de pago. paused es true cuando hay una dirección configurada y el espacio de trabajo está en el plan gratuito.

Tu bandeja de entrada,
en tus propios términos.

Infraestructura de correo para empresas, IA, agentes y correo personal. Creada para escalar, con privacidad y control. Todo lo que el correo debería haber tenido desde el primer día.

© 2026 OpenEmail. Todos los derechos reservados.