Skip to main content
GET
Buscar cliente completo

Authorizations

apiKey
string
header
required

API key no formato keyId.secret.

Query Parameters

id
string
required

Response

Cliente completo.

_id
string

ID do cliente.

companyId
string

ID da empresa vinculada ao cliente.

name
string

Nome do cliente.

doc
string

Documento do cliente.

cpf
string

CPF do cliente, quando presente no payload legado.

email
string<email>

E-mail do cliente.

phone
string[]

Telefones do cliente.

status
enum<string>

Status do cliente.

Available options:
ACTIVE,
ERROR_PAYMENT,
PENDING_PAYMENT,
NO_PAYMENT,
CANCELED_ALERT_ETHOCA
type
enum<string>

Tipo do cliente.

Available options:
INDIVIDUAL,
COMPANY
active
boolean

Indica se o cliente esta ativo.

deleted
boolean

Indica exclusao logica do cliente, quando preenchido.

referenceId
string

Referencia externa da sua aplicacao.

createdAt
string<date-time>

Data de criacao do cliente.

lastUpdate
string<date-time>

Data da ultima atualizacao do cliente.