Listar remitentes

GET/v1/senders

Para desarrolladores

Descripción

Devuelve una lista paginada de remitentes registrados en la instancia.

Guía relacionada

• Crear un remitente — Autorice la dirección que figurará como origen de sus envíos.

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

Query params:

namestring | null

Filtra por nombre del remitente, con coincidencia parcial y sin distinguir mayúsculas (ver Filtros de texto).

emailstring | null

Filtra por email del remitente, con coincidencia parcial y sin distinguir mayúsculas (ver Filtros de texto).

is_domain_verifiedboolean | null

true devuelve únicamente remitentes cuyo dominio tiene las cuatro verificaciones DNS (MX, SPF, DKIM, DMARC) aprobadas. Si se omite, no se filtra.

pageinteger

Número de página; la primera es la 1. Default: 1.

page_sizeinteger

Tamaño de página, 1–100. Default: 20.

Response

200 OKDevuelve una página de resultados: data con los elementos y pagination para pedir la siguiente. Cada elemento tiene 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

—

Notas

• Cada elemento tiene los mismos campos que GET /v1/senders/{id}.
• Toda colección de la API responde con {data, pagination}. El detalle está en Paginación y formato de respuesta.

Request

curl -X GET "https://$API_HOST/v1/senders?is_domain_verified=true&page=1&page_size=20" \
-H "Authorization: Bearer $API_KEY" \
-H "X-Instance-Slug: $SLUG"

Response

{
"data": [
  {
    "id": 42,
    "name": "Atención al cliente",
    "email_address": "[email protected]",
    "...": "..."
  }
],
"pagination": {
  "page": 1,
  "page_size": 20,
  "has_more": false,
  "total_items": 1,
  "total_pages": 1
}
}