Cliente

Busca de Clientes

Lê uma lista de Clientes com base no filtro informado na URL da requisição.

get/api/empresarial/v1/cliente

Request

  • Base URL: https://api-docs.wk.com.br (the document declares no server; this is the origin it was published from)
  • URL: https://api-docs.wk.com.br/api/empresarial/v1/cliente
  • Auth: HTTP bearer

Query parameters

TipoPessoa'Todos' | 'Fisica' | 'Juridica'
Situacao'Todos' | 'Inativo' | 'Ativo'
RazaoSocialstring
NomeFantasiastring
Codigostring
IdVendedorstring
IdRepresentantestring
IdMunicipiostring
UFstring
InformacoesExtras.InfExtra1string
InformacoesExtras.InfExtra2string
InformacoesExtras.InfExtra3string
InformacoesExtras.InfExtra4string
DataHoraGravacaoInicialstring date-time
DataHoraGravacaoFinalstring date-time
CpfCnpjstring
Idsstring[]

IDs dos registros a serem filtrados. Caso seja passado um ID inválido ou inexistente o dado será retornado como null.

CodigosIntegradorstring[]

Códigos de integrador dos registros a serem filtrados.

Fieldsstring[]

Campos retornados na busca.

Response

OK

idstring nullable
codigoIntegradorstring nullable
codigostring nullable
cpfCnpjstring nullable
tipoPessoa'Fisica' | 'Juridica'
classificacaoParalelastring nullable
classificacaostring nullable
razaoSocialstring nullable
nomeFantasiastring nullable
idEmpresaGrupostring nullable
contatostring nullable
emailstring nullable
homepagestring nullable
inativoboolean
ativoInativoDesdestring date
vendaBloqueadaboolean
caracteristicasRadarAPIModelEmpresarialDtosV1CFRTEnumsCaracteristicasDto[] nullable
idCategoria1string nullable
idCategoria2string nullable
idCategoria3string nullable

Changes

No recorded changes to this operation across all 1 revision of this API.