Skip to main content
GET
Obter Clientes
Use dataInferior/dataSuperior para limitar a janela consultada. Sem filtro, a resposta pode ser volumosa.

Authorizations

Authorization
string
header
required

Envie o token retornado por /v2/autenticar no header Authorization, no formato Bearer {token}.

Query Parameters

cnpjcpf
string

CNPJ ou CPF do cliente. Quando informado, ignora os demais filtros e retorna um único registro.

idws
string

Identificador externo do cliente (IdClienteWS). Quando informado, ignora os demais filtros e retorna um único registro.

dataInferior
string

Data/hora inferior de atualização. Formatos aceitos: dd/MM/yyyy ou dd/MM/yyyy HH:mm.

dataSuperior
string

Data/hora superior de atualização. Formatos aceitos: dd/MM/yyyy ou dd/MM/yyyy HH:mm.

Response

Sucesso.

success
boolean
Example:

true

data
object

Um único cliente quando cnpjcpf ou idws são informados; uma lista de clientes caso contrário.