Buscar remitentes por nombre

GET/v1/senders/search/names

Descripción

Busca remitentes por nombre y retorna opciones livianas (id + nombre), pensadas para poblar un componente de autocompletar sin traer el objeto remitente completo.

Autenticación

Authorizationbearer tokenheaderobligatorio

API key con scope senders:read. Formato: Bearer FD.<key_id>.<token>.

X-Instance-Slugstringheaderobligatorio

Request

Query params:

qstringobligatorio

Texto de búsqueda sobre el nombre del remitente - coincidencia parcial, insensible a mayúsculas (ver Filtros de texto). Mínimo 3 caracteres: un valor más corto responde 422.

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.

valuestringobligatorio

Nombre del remitente (el campo que coincidió con q).

Notas

• Para buscar por email en vez de nombre, ver GET .../search/emails.
• 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/names?q=aten" \
-H "Authorization: Bearer $API_KEY" \
-H "X-Instance-Slug: $SLUG"

Response

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