addresses

Listar destinatarios del directorio

Misma visibilidad que GET /senders. Un destinatario siempre pertenece a un remitente (sender_id). Requiere scope addresses:read.

get/recipients

Request

  • Base URL: https://api.enviadores.com.mx/api/v1
  • URL: https://api.enviadores.com.mx/api/v1/recipients
  • Auth: HTTP bearer

Query parameters

pageinteger
limitinteger
sender_idstring

Solo destinatarios de este remitente.

postal_codestring
qstring

Búsqueda de texto sobre nombre, alias, teléfono, email y dirección (calle/colonia/ciudad/estado/CP). Cada palabra debe aparecer en ALGÚN campo, no necesariamente en el mismo. Insensible a acentos y mayúsculas; se consideran las primeras 5 palabras.

Headers

X-PDV-IDstring

Solo llaves de cuentas admin: el punto de venta cuyo fondo se carga/consulta. Requiere que la llave tenga una allowlist de PDVs configurada por un administrador (pdv_allowlist); sin allowlist, todo PDV real es denegado por defecto. Validado además contra los PDV activos. Cualquier violación → 403 PDV_NOT_ALLOWED. El valor personal_account equivale a omitir el header.

Response

Página de destinatarios.

successunknown required
requestIdstring required

Correlación de logs; también en el header X-Request-Id.

Changes

No recorded changes to this operation across all 1 revision of this API.