Listar clientes
El listado de clientes del comercio, paginado por límite y desplazamiento.
GET/v1/clients/listAPI key del comercio
Trae el listado de clientes del comercio, paginado en formato límite y desplazamiento.
Parámetros
limitintegerqueryCuántos clientes traer por página. De 1 a 100. Por defecto, 20.
offsetintegerqueryDesde qué posición arrancar. Por defecto, 0.
Respuesta
itemsarray de clientesrequeridoLos clientes de esta página. Ver Cliente.
totalinteger | nullrequeridoCantidad total de clientes del comercio, sin paginar.
limitinteger | nullrequeridoEl límite aplicado.
offsetinteger | nullrequeridoEl desplazamiento aplicado.
Ejemplo
curl https://loybox-public-api-752998171300.southamerica-west1.run.app/v1/clients/list?limit=2&offset=0 \
-H "Authorization: Bearer $LOYBOX_API_KEY"// 200 OK
{
"items": [
{
"code": 12345,
"username": "Ana Pérez",
"email": "ana@example.com",
"points": 340
},
{
"code": 12346,
"username": "Bruno Díaz",
"email": "bruno@example.com",
"points": 0
}
],
"total": 1875,
"limit": 2,
"offset": 0
}Para recorrer todo el listado, andá sumando limit al offset hasta que la
suma llegue a total.
Errores
| Código | Cuándo |
|---|---|
401 | La API key es inválida: no tiene un comercio asociado. |
422 | limit está fuera del rango de 1 a 100, o offset es negativo. |