Buscar remitentes por email

GET/v1/senders/search/emails

Para desarrolladores

Descripción

Devuelve el id y la dirección de email de los remitentes que coinciden con un texto. Sirve para un campo de autocompletar, sin traer el remitente completo.

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:

qstringobligatorio

Texto que se busca en email_address, con coincidencia parcial y sin distinguir mayúsculas (ver Filtros de texto). Mínimo 3 caracteres.

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.

valuestringsiempre presente

Dirección de email del remitente (el campo que coincidió con q).

Notas

• Para buscar por nombre en vez de email, use GET /v1/senders/search/names.
• q requiere al menos 3 caracteres. Un valor más corto responde 422 con el detalle del campo en errors[]; no es una búsqueda vacía.

Request

curl -X GET "https://$API_HOST/v1/senders/search/emails?q=contacto" \
-H "Authorization: Bearer $API_KEY" \
-H "X-Instance-Slug: $SLUG"

Response

{
"data": [
  {
    "id": 42,
    "value": "[email protected]"
  }
],
"pagination": {
  "page": 1,
  "page_size": 20,
  "has_more": false,
  "total_items": 1,
  "total_pages": 1
}
}