Listar clientes do Clube de Fidelidade

Retorna, de forma paginada, os clientes do Clube de Fidelidade do restaurante autenticado, com dados relevantes para CRM: cadastro, saldo de cashback, pontos, visitas, produto favorito, histórico de resgates e histórico de mensagens enviadas. **Observações** - Disponível apenas para restaurantes com Clube de Fidelidade configurado. Caso contrário, retorna `400 clube_not_configured`. - Cada cliente pertence somente à loja autenticada — clientes de outras lojas nunca são retornados. - `messages` contém apenas mensagens **enviadas** ao cliente (não há registro de mensagens recebidas). - `cashback`, `total_spent` e `points` podem ser retornados como string numérica. - `cashback_expires_at` é a data em que o cashback do cliente expira; ela é renovada a cada nova compra e pode ser `null` se o cliente ainda não acumulou cashback. - `favorite_product` pode ser `null` quando o cliente ainda não tem compras suficientes.

Observações

Disponível apenas para restaurantes com Clube de Fidelidade configurado. Caso contrário, retorna 400 clube_not_configured.
Cada cliente pertence somente à loja autenticada — clientes de outras lojas nunca são retornados.
messages contém apenas mensagens enviadas ao cliente (não há registro de mensagens recebidas).
cashback, total_spent e points podem ser retornados como string numérica.
cashback_expires_at é a data em que o cashback do cliente expira; ela é renovada a cada nova compra e pode ser null se o cliente ainda não acumulou cashback.
favorite_product pode ser null quando o cliente ainda não tem compras suficientes.

Authorization

bearerAuth

AuthorizationBearer <token>

Token JWT obtido em POST /public/api/sessions. Envie como Authorization: Bearer {token}.

In: header

Query Parameters

page?integer

Página (1-based).

per_page?integer

Itens por página (1 a 200).

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/clube/clients"

{  "page": 1,  "per_page": 100,  "total": 1234,  "total_pages": 13,  "clients": [    {      "name": "Matheus",      "phone": "(99) 99999-9999",      "cashback": "25.50",      "cashback_expires_at": "2025-09-16T18:22:39.380Z",      "points": "120",      "visits": 8,      "gender": "male",      "birthday": "1995-06-18",      "total_spent": "430.00",      "favorite_product": "X-Tudo",      "rescues": [        {          "value": "10.00",          "date": "2019-08-24T14:15:22Z"        }      ],      "messages": [        {          "type": "cashback",          "phone": "(99) 99999-9999",          "date": "2019-08-24T14:15:22Z"        }      ]    }  ]}

{  "error": "clube_not_configured",  "message": "Restaurante não possui Clube de Fidelidade configurado."}

{  "error": "token_invalid",  "message": "Token inválido ou expirado."}

{  "error": "clube_request_failed",  "message": "Erro ao consultar clientes do clube."}

Listar clientes do Clube de Fidelidade

Authorization

Query Parameters

Response Body

200application/json

400application/json

401application/json

502application/json

`application/json`

`application/json`

`application/json`

`application/json`