Estás en: Documentación › Gestión › Listar clientes
Listar clientes
Parámetros que acepta este endpoint y campos que devuelve.
GET
/v1/customersPermiso necesario en la clave: customers:read (o *).
Parámetros de ruta
Este endpoint no tiene parámetros de ruta.
Parámetros de consulta
Van en la dirección, detrás de ? y separados por &. Todos son opcionales.
| Nombre | Tipo | Obligatorio | Qué hace | Ejemplo |
|---|---|---|---|---|
q | texto | No | Búsqueda de texto libre. Compara con los campos principales del recurso (nombre, código, NIF, matrícula…). | martin |
updated_since | fecha y hora ISO 8601 | No | Solo registros creados o modificados desde ese momento (ISO 8601 UTC). Sirve para sincronizar solo cambios. | 2026-11-01T00:00:00Z |
limit | número entero | No | Cuántos registros devuelve cada página (1 a 100). Por defecto 25. | 50 |
page | número entero | No | Número de página, empezando en 1. Con meta.has_more = true hay más páginas. | 1 |
Campos de la respuesta
| Campo | Tipo | Qué contiene |
|---|---|---|
id | número entero | Identificador interno del cliente. |
code | texto | Código de cliente. |
name | texto | Nombre o razón social. |
alias | texto | Nombre comercial, si lo hay. |
tax_id | texto | NIF / CIF. |
type | texto (lista) | customer, prospect, customer_prospect u other. |
address | texto | Dirección. |
zip | texto | Código postal. |
town | texto | Población. |
country | texto | País (código ISO). |
phone | texto | Teléfono. |
email | texto | Correo electrónico. |
active | sí / no | true si el cliente está activo. |
created_at | fecha y hora ISO 8601 | Alta. Fecha y hora ISO 8601 en UTC. |
updated_at | fecha y hora ISO 8601 | Última modificación. Fecha y hora ISO 8601 en UTC. |