Skip to main content
GET
Listar clientes

Authorizations

x-api-key
string
header
required

API key del comercio. Se genera desde el panel de Tienda de Puntos, en Configuración → Integraciones.

Query Parameters

order
enum<string>

Campo por el que ordenar.

Available options:
fullName,
currentPoints,
lastOperation,
createdAt
levelId
number

Devuelve solo los clientes de este nivel. Los IDs salen de GET /external/levels.

Example:

3

tagId
number

Devuelve solo los clientes con esta etiqueta del comercio.

Example:

4

currentPointsMin
number

Puntos disponibles mínimos.

Example:

100

currentPointsMax
number

Puntos disponibles máximos.

Example:

5000

lastOperationFrom
string

Clientes con última suma de puntos desde esta fecha (ISO 8601).

Example:

"2026-07-01"

lastOperationTo
string

Clientes con última suma de puntos hasta esta fecha (ISO 8601).

Example:

"2026-07-31"

page
integer
default:1
Required range: x >= 1
Example:

1

limit
integer
default:10

Cantidad de resultados por página. Máximo 200.

Required range: 1 <= x <= 200
Example:

10

query
string

Búsqueda parcial por nombre.

Example:

"café"

direction
enum<string>
default:desc

Sentido del orden. Solo aplica si se envía order.

Available options:
asc,
desc

Response

Página de clientes. Sin envelope.

data
object[]
meta
object