Pular para o conteúdo principal

Listar clientes

GEThttps://carchost.fieldcontrol.com.br/customers

Lista os clientes da conta, com paginação, filtros e ordenação.

Requer os headers X-Api-Key e User-Agent. Limite: 1 requisição por segundo (saiba mais).

Requisição​

Parâmetros de consulta

limitinteger

Quantidade de itens por página.

De 1 a 100.Padrão: 10.

offsetinteger

Quantidade de itens a pular.

De 0 a 200000.Padrão: 0.

qstring

Filtros no formato campo:valor, separados por espaço (como filtrar). Os filtros aceitos estão na tabela abaixo.

Exemplo: document_number:27032236881 archived:false.

FiltroO que faz
name

Nome do cliente, exatamente igual ao cadastrado.

code

Código do cliente.

document_number

CPF ou CNPJ do cliente, somente números.

external_id

Identificador do cliente no seu sistema (external.id).

archived

true para arquivados, false para ativos.

created_at

Data de criação igual à informada (ISO 8601, UTC).

created_at>=

Criados a partir da data informada, inclusive.

created_at<=

Criados até a data informada, inclusive.

created_at>

Criados depois da data informada.

created_at<

Criados antes da data informada.

sortstring

Ordenação. -created_at ordena do mais recente para o mais antigo.

Valores aceitos: id, created_at, -created_at.Padrão: id.

Headers

User-Agentstringobrigatório

Identificação da sua aplicação.

Exemplo: MinhaIntegracao/1.0.

Respostas

  • 200

    Lista de clientes.

  • 401

    Chave de API ausente (Missing API Key) ou inválida (Invalid API Key). Ver Autenticação.

  • 403

    Conta bloqueada (Account blocked), expirada (Account expired) ou com plano que não permite integração (Account plan not allowed). Ver Autenticação.

  • 422

    Filtro, paginação ou ordenação inválidos (parametersValidationErr).

  • 429

    Limite de 1 requisição por segundo excedido. Ver Limite de requisições.

  • 500

    Erro inesperado no servidor.