Retornar todos os clientes cadastrados no estabelecimento
Retornar listagem dos clientes cadastrados no programa de fidelidade de um determinado estabelecimento.
bash
curl --location --request GET 'https://sandbox.fidelizii.com.br/api/v4/estabelecimentos/999999/clientes' \
--header 'app-token: {{app-token}}' \
--header 'access-token: {{access-token}}' \
--header 'Accept: application/json'Este endpoint poderá contemplar os seguintes parâmetros GET:
| Parâmetro | Descrição |
|---|---|
| q | Parâmetro usado para filtrar o cliente por nome, email, CPF ou celular. |
| data_inicio | Filtrar os clientes pela data inicial de cadastro |
| data_fim | Filtrar os clientes pela data final de cadastro |
| ordenado_por | Ordenação da listagem (data_cadastro,nome,compras,ultima_compra,primeira_compra,receita) |
| itens_por_pagina | Quantidade de clientes retornados por página (Máximo: 200 clientes) |
| page | Número da paginação dos clientes |
No retorno deverá conter:
json
{
"success": true,
"message": "Clientes retornados com sucesso",
"data": {
"current_page": 1,
"data": [
{
"id_cliente": 3558808,
"nome": "NOME DO CLIENTE",
"email": "email@email.com.br",
"data_cadastro": "2025-05-07 01:58:42",
"celular": "+5541854148484",
"data_nascimento": "1990-04-24",
"genero": "NA",
"cep": null,
"endereco": null,
"bairro": null,
"cidade": null,
"uf": null,
"carteira": {
"saldo": 2, // saldo atual do cliente
"saldo_carencia": 0, // caso o programa possua carência de pontos habilitada, será exibida a quantidade de pontos que irá ser contabilizada no dia seguinte
"pontos_vencidos": [], // array com a lista de pontos vencidos do cliente
"pontos_vencendo": [ // array com a lista dos próximos vencimentos de pontos do cliente
{
"id_cartela_cliente": 4016927,
"pontos": 2,
"data": "2025-05-07 01:59:18",
"tipo": "credito",
"data_validade": "2026-05-31"
}
]
},
"receita": 32, // Receita total gerada pelo cliente
"compras": 1, // Número de compras realizadas
"primeira_compra": "2025-05-07 01:59:18",
"ultima_compra": "2025-05-07 01:59:18",
"conquistados_premio_fidelidade": 0,
"conquistados_brinde_roleta": 0,
"conquistados_premio_surpresa": 0,
"conquistados_premio_campanha": 0,
"conquistados_premio_game": 0,
"pendente_resgate_premio_fidelidade": 0,
"pendente_resgate_brinde_roleta": 0,
"pendente_resgate_premio_surpresa": 0,
"pendente_resgate_premio_campanha": 0,
"pendente_resgate_premio_game": 0,
"resgatado_premio_fidelidade": 0,
"resgatado_brinde_roleta": 0,
"resgatado_premio_surpresa": 0,
"resgatado_premio_campanha": 0,
"resgatado_premio_game": 0,
"expirado_premio_fidelidade": 0,
"expirado_brinde_roleta": 0,
"expirado_premio_surpresa": 0,
"expirado_premio_campanha": 0,
"expirado_premio_game": 0
}
],
"first_page_url": "https://sandbox.fideliziicom.br/api/v4/estabelecimentos/9999/clientes?page=1",
"from": 1,
"last_page": 85,
"last_page_url": "https://sandbox.fideliziicom.br/api/v4/estabelecimentos/9999/clientes?page=85",
"next_page_url": "https://sandbox.fideliziicom.br/api/v4/estabelecimentos/9999/clientes?page=2",
"per_page": 1,
"prev_page_url": null,
"to": 1,
"total": 85
}
}