Pular para o conteúdo principal

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

NomeTipoDescrição
userIdnumberIdentificador do usuário
establishmentIdnumberIdentificador do estabelecimento
clientIdstringIdentificador 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:

CampoTipoDescrição
idnumberIdentificador interno do token (usado para remoção).
establishmentIdnumberEstabelecimento ao qual o token pertence.
clientIdstringCliente ao qual o token está vinculado.
tokenstringValor do token.
expire_atstring | nullData de expiração do token, quando aplicável (YYYY-MM-DD HH:MM:SS).
created_atstringData de criação (YYYY-MM-DD HH:MM:SS).
updated_atstringData 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).