Saltar al contenido principal

Obtener un remitente

GET/v1/senders/{id}

Para desarrolladores

Descripción​

Devuelve un remitente por su id, con su dirección, su dominio y si ese dominio está verificado. El alta y la baja de un remitente se hacen solo en el panel web.

Cada elemento de data en GET /v1/senders tiene esta misma estructura.

Guía relacionada​

Autenticación​

Authorizationbearer tokenheaderobligatorio
API key con scope senders:read. Formato: Bearer <API_KEY>.
X-Instance-Slugstringheaderobligatorio
Identificador de su instancia. Ver Autenticación.

Request​

Path params:

idintegerobligatorio
Identificador del remitente, devuelto por `GET /v1/senders`.

Response​

200 OKDevuelve un objeto con los campos que siguen.
idintegersiempre presente
Identificador del remitente.
namestringsiempre presente
Nombre visible del remitente.
email_addressstringsiempre presente
Dirección de envío, username@<domain>.
domain_idintegersiempre presente
id del dominio asociado.
domain_is_verifiedbooleansiempre presente
Estado de verificación del dominio asociado. Se recalcula en cada consulta: refleja el estado actual del dominio, no el que tenía cuando se registró el remitente. Si el dominio pasa a failed, este campo es false en la siguiente lectura.
is_consent_requiredbooleansiempre presente
true cuando el envío desde este remitente exige verificar el consentimiento del destinatario contra sus finalidades declaradas. Gestionable solo desde el panel web.
created_atstring (date-time)siempre presente
—
updated_atstring (date-time)siempre presente
—

Errores​

CódigoCuándo
404No existe un remitente con ese id en la instancia (sender_not_found).

Detalle en Errores genéricos.

Request
curl -X GET "https://$API_HOST/v1/senders/42" \
-H "Authorization: Bearer $API_KEY" \
-H "X-Instance-Slug: $SLUG"
Response
{
"id": 42,
"name": "Atención al cliente",
"email_address": "[email protected]",
"domain_id": 7,
"domain_is_verified": true,
"is_consent_required": false,
"created_at": "2026-05-08T14:24:10Z",
"updated_at": "2026-05-08T14:24:10Z"
}