Clickfin

Referência da API
Portal oficial
GET/client/options

Listar opções de clientes para seleção

Retorna todos os clientes não excluídos da empresa autenticada com campos mínimos (_id, name, tradeName), ordenados por razão social. Destinado a comboboxes e filtros; a listagem paginada completa permanece em GET /client.

AcessoChave de API · clients:read
Parâmetros1
Respostas7

Parâmetros

  • statusquery

    Filtra clientes pelo status (0 = inativo, 1 = ativo).

Respostas

200Sucesso

Opções de clientes retornadas com sucesso.

400Erro

Erro de validação nos parâmetros da query ou empresa não selecionada no token.

401Erro

Erro de autenticação.

403Erro

Acesso comercial bloqueado ou sem permissão.

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.