Listar clientes do Clube de Fidelidade (V2 paginada)

Console de requisiçõesConfigure os dados, envie e inspecione a resposta.

GETProxy seguro

RequisiçãoEdite os campos antes de enviar

Código e respostasExemplos prontos para copiar

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

{  "data": [    {      "name": "Matheus",      "phone": "(99) 99999-9999",      "cashback": "25.50",      "cashback_expires_at": "2025-09-16T18:22:39.380Z",      "cashback_updated_at": "2025-09-02T14:10:03.120Z",      "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"        }      ]    }  ],  "pagination": {    "count": 0,    "limit": 1,    "total": 0,    "has_more": true,    "next": null  }}

{  "statusCode": 400,  "message": "string",  "key": "restaurant_id_required"}

{  "statusCode": 400,  "message": "string",  "key": "restaurant_id_required"}

{  "statusCode": 400,  "message": "string",  "key": "restaurant_id_required"}

{  "statusCode": 400,  "message": "string",  "key": "restaurant_id_required"}

Retorna uma página de clientes do Clube. Com OAuth, exige o escopo clube:read; a sessão do restaurante também é aceita. O restaurante precisa ter o Clube configurado.

Retorna data e pagination; siga pagination.next mantendo os filtros. A V1 permanece disponível com seu contrato anterior.

Authorization

bearerAuth

AuthorizationBearer <token>

Access token OAuth obtido em POST /oauth/token ou sessão autenticada do restaurante emitida pelo login Takeat. Tokens OAuth exigem os escopos de cada operação. A sessão não usa escopos de integração e fica limitada ao restaurant_id assinado. Chaves tk_ não são aceitas.

In: header

Query Parameters

restaurant_id?integer

Omitido para sessões de restaurante ou credenciais com uma única loja. Obrigatório quando uma chave ou autorização OAuth multilojas, ou um parceiro, cobre várias lojas. É validado contra as lojas atualmente autorizadas pela credencial. Em uma sessão, um valor diferente do restaurant_id assinado responde 403.

page?integer

per_page?integer

Listar clientes do Clube de Fidelidade (V2 paginada)

Authorization

Query Parameters

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Authorization

Query Parameters

Response Body

200application/json

400application/json

401application/json

403application/json

502application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`