Listar clientes com paginação
Retorna uma lista paginada de clientes não excluídos associados à empresa do usuário autenticado. Requer perfil de Administrador.
clients:readParâmetros
- pagequery
Número da página para a paginação.
- limitquery
Quantidade de itens por página.
- namequery
Filtra parcialmente pela razão social, sem diferenciar maiúsculas de minúsculas.
- tradeNamequery
Filtra parcialmente pelo nome fantasia, sem diferenciar maiúsculas de minúsculas.
- cpfCnpjquery
Filtra parcialmente pelo CPF ou CNPJ armazenado.
- emailquery
Filtra parcialmente os e-mails do cliente.
- statusquery
1 para ativo e 0 para inativo.
- taxRegimequery
Filtra pelo regime tributário exato.
- companySizequery
Filtra pelo porte da empresa exato.
- marketSegmentquery
Identificador do segmento de mercado.
- originquery
Filtra pela origem exata do cliente.
Respostas
Lista de clientes retornada com sucesso.
Erro de validação nos parâmetros da query ou empresa não selecionada no token.
Erro de autenticação. O token não foi fornecido, é inválido ou expirou.
Erro de autorização. O usuário não tem permissão para acessar este recurso.
Configuração de ambiente JWT ausente.
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.
Erro interno inesperado.
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.