Saltar al contenido principal

Listar remitentes

GET/v1/senders

Descripción​

Retorna una lista paginada de remitentes registrados en la instancia.

Autenticación​

Authorizationbearer tokenheaderobligatorio
API key con scope senders:read. Formato: Bearer FD.<key_id>.<token>.
X-Instance-Slugstringheaderobligatorio

Request​

Query params:

namestring | null
Filtra por nombre del remitente - coincidencia parcial, insensible a mayúsculas. Ver Filtros de texto.
emailstring | null
Filtra por email del remitente - coincidencia parcial, insensible a mayúsculas. Ver Filtros de texto.
is_domain_verifiedboolean | null
true retorna únicamente remitentes cuyo dominio tiene las cuatro verificaciones DNS (MX, SPF, DKIM, DMARC) aprobadas. Omitido: sin filtro.
pageinteger
Página, 1-indexed. 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.
idintegerobligatorio
Identificador del remitente.
namestringobligatorio
Nombre visible del remitente.
email_addressstringobligatorio
Dirección de envío, username@<domain>.
domain_idintegerobligatorio
id del dominio asociado.
domain_is_verifiedbooleanobligatorio
Estado de verificación del dominio asociado. Se recalcula en cada consulta, así que refleja el estado del dominio al momento de leer, no el que tenía cuando se registró el remitente: si el dominio se degrada a failed, este campo pasa a false en la siguiente lectura.
is_consent_requiredbooleanobligatorio
true cuando el envío a este remitente exige verificar el consentimiento del destinatario contra sus finalidades declaradas. Gestionable solo desde el panel web.
created_atstring (date-time)obligatorio
—
updated_atstring (date-time)obligatorio
—
Nota

Cada elemento tiene los mismos campos que GET /v1/senders/{id}.

El envelope {data, pagination} es el estándar de toda colección de la API — semántica completa 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": "contacto@correos.micomercio.cl",
    "...": "..."
  }
],
"pagination": {
  "page": 1,
  "page_size": 20,
  "has_more": false,
  "total_items": 1,
  "total_pages": 1
}
}