Lista tokens do cliente
GET /api/{userId}/establishment/{establishmentId}/clients/{clientId}/tokens
Retorna todos os tokens vinculados ao cliente dentro do estabelecimento informado.
Parâmetros de rota
| Nome | Tipo | Descrição |
|---|---|---|
userId | number | Identificador do usuário |
establishmentId | number | Identificador do estabelecimento |
clientId | string | Identificador do cliente |
Requisição
- Método:
GET - Path:
/api/\{userId\}/establishment/\{establishmentId\}/clients/\{clientId\}/tokens - Headers:
Authorization,Accept: application/json
Formato da resposta (JSON)
Segue o envelope padrão da API:
- Sucesso (HTTP 200):
{ "response": "success", "data": <payload> } - Erro (HTTP 400):
{ "response": "error", "data": { "msg": "...", "code": "..." } }
Payload
O data é um array de tokens. Quando o cliente não possui tokens cadastrados, a API retorna um array vazio.
Cada item representa um registro em jump_client_tokens:
| Campo | Tipo | Descrição |
|---|---|---|
id | number | Identificador interno do token (usado para remoção). |
establishmentId | number | Estabelecimento ao qual o token pertence. |
clientId | string | Cliente ao qual o token está vinculado. |
token | string | Valor do token. |
expire_at | string | null | Data de expiração do token, quando aplicável (YYYY-MM-DD HH:MM:SS). |
created_at | string | Data de criação (YYYY-MM-DD HH:MM:SS). |
updated_at | string | Data da última atualização (YYYY-MM-DD HH:MM:SS). |
Exemplo de resposta (JSON)
{
"response": "success",
"data": [
{
"id": 18,
"establishmentId": 7724,
"clientId": "772420260215093421",
"token": "ABC123XYZ",
"expire_at": null,
"created_at": "2026-03-10 14:22:07",
"updated_at": "2026-03-10 14:22:07"
},
{
"id": 22,
"establishmentId": 7724,
"clientId": "772420260215093421",
"token": "QWE456RTY",
"expire_at": "2026-12-31 23:59:59",
"created_at": "2026-04-01 09:10:15",
"updated_at": "2026-04-01 09:10:15"
}
]
}
Exemplo sem tokens
{
"response": "success",
"data": []
}
Nuâncias
- Um mesmo cliente pode ter múltiplos tokens no mesmo estabelecimento.
- O valor do
tokené único por estabelecimento: tentativas de cadastro do mesmo token no mesmo estabelecimento são rejeitadas (ver Adiciona token).