Skip to main content
GET
Get a client by ID

Authorizations

Authorization
string
header
required

Use Authorization: Bearer esk_live_... or esk_test_... for API access

Path Parameters

id
string
required

Response

id
string<uuid>
required
firstName
string
required
Example:

"João"

lastName
string
required
Example:

"Silva"

phone
string
required
Example:

"11999999999"

organizationId
string<uuid>
required
status
enum<string>
required
Available options:
UP_TO_DATE,
OVERDUE
Example:

"OVERDUE"

createdAt
object
required
updatedAt
object
required
cpf
object | null
Example:

"12345678901"

email
object | null
occupation
object | null
observation
object | null
cep
object | null
city
object | null
neighborhood
object | null
street
object | null
address
object | null
streetNumber
object | null
state
object | null
Example:

"SP"

isSandbox
boolean
debtCount
number
totalDebtAmount
number
outstandingAmount
number
openDebtCount
number
overdueDebtCount
number
paidDebtCount
number
nextDueDate
object | null
channelPreferences
object
overIndebtednessReportedAt
string<date-time> | null

Quando o cliente informou estar em processo de superendividamento (Lei 14.181/2021). Enquanto preenchido, toda a cobrança dele fica pausada; só um administrador retoma.

overIndebtednessSource
enum<string> | null

Quem ouviu: o agente do WhatsApp (agent) ou o de voz (voice).

Available options:
agent,
voice