Clickfin

Referência da API
Portal oficial
GET/client/{clientId}

Obter um cliente por ID

Retorna os detalhes de um cliente específico pelo seu ID. O cliente deve pertencer ao licenciado do usuário autenticado. Requer perfil de Administrador.

AcessoChave de API · clients:read
Parâmetros1
Respostas8

Parâmetros

  • clientIdpath

    ID do cliente a ser retornado.

Respostas

200Sucesso

Cliente retornado com sucesso.

400Erro

Erro de validação no ID do cliente ou empresa não selecionada no token.

401Erro

Erro de autenticação. O token não foi fornecido, é inválido ou expirou.

403Erro

Erro de autorização. O usuário não tem permissão para acessar este recurso.

404Erro

Cliente não encontrado, excluído, pertencente a outro licenciado ou a outra empresa do licenciado (a consulta usa a empresa selecionada no token), ou configuração de ambiente JWT ausente. Cliente de outro licenciado ou de outra empresa do mesmo licenciado retorna 404 CLIENT.GET.NOT_FOUND.

429Erro

Limite de requisições excedido (RATE_LIMIT.EXCEEDED). Por chave: 120 requisições por minuto (janela fixa de 60 s); o 429 da chave traz X-RateLimit-* da chave. Por IP, para tráfego com chave: 600 requisições em 10 minutos; esse 429 traz só Retry-After, sem X-RateLimit-* (os cabeçalhos descrevem apenas o limite da chave). Aguarde Retry-After segundos antes de tentar de novo.

500Erro

Erro interno inesperado.

503Erro

Credencial não pôde ser verificada por falha temporária do servidor (AUTH.SESSION_UNAVAILABLE). Não invalida a chave nem a sessão: repita com backoff.