Consultar lista de clientes

Consulta una lista paginada de clientes del negocio actual.

Autenticación requerida: Este endpoint requiere autenticación Bearer Token. Usar el campo tokenCurrent obtenido del servicio de login (/login) en el header: Authorization: Bearer {tokenCurrent}

Características:

  • Soporta paginación para manejo eficiente de grandes listas
  • Incluye filtros de búsqueda por nombre, teléfono, documento, email
  • Búsqueda flexible con múltiples palabras clave
  • Ordenación automática por nombre
  • Respeta configuración de compartir clientes con negocio padre

Limitaciones plan trial: Las cuentas en periodo de prueba solo pueden ver clientes de las últimas 24 horas.

Ejemplos de Uso

1. Consultar todos los clientes (primera página)

GET /clients?pagination=true&limit=10&page=0
Authorization: Bearer tu_token_aqui

Consulta los primeros 10 clientes ordenados por nombre.

2. Buscar cliente por nombre

GET /clients?filter=Juan&pagination=true&limit=10&page=0
Authorization: Bearer tu_token_aqui

Busca clientes que contengan "Juan" en nombre o apellido.

3. Búsqueda por múltiples palabras

GET /clients?filter=Maria Lopez&pagination=true&limit=10&page=0
Authorization: Bearer tu_token_aqui

Busca clientes que contengan tanto "Maria" como "Lopez".

4. Búsqueda por teléfono

GET /clients?filter=300123&pagination=true&limit=10&page=0
Authorization: Bearer tu_token_aqui

Busca clientes por número de teléfono (búsqueda flexible con espacios).

5. Búsqueda avanzada por datos generales

GET /[email protected]&pagination=true&limit=10&page=0
Authorization: Bearer tu_token_aqui

Busca en todos los campos del cliente (nombre, apellido, documento, email, teléfono, dirección).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
boolean
Defaults to true

Activar paginación de resultados

integer
1 to 10000
Defaults to 10

Número máximo de clientes por página

integer
≥ 0
Defaults to 0

Número de página (inicia en 0)

string

Filtro de búsqueda por nombre, apellido, documento o teléfono

string

Búsqueda avanzada en todos los campos del cliente

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json