Pular para o conteúdo

GET /v1/contacts

GET
/v1/contacts
curl --request GET \
--url https://seu-endereco-da-api/v1/contacts \
--header 'Authorization: Bearer <token>'

Permissão que a Chave de acesso precisa: Ler contatos (contacts:read).

cursor
string

Opaque pagination cursor

limit
string

Page size (default 50, max 200)

Media typeapplication/json
object
items
required
Array<object>
object
canEdit
required

The caller may edit this contact

boolean
id
required
string
name
required
string
phoneNumber
required
string
email
required

Masked to the domain for readers without contacts:read_phone

string
nullable
provider
required
string
attributes
required
object
key
additional properties
any
hiddenAttributes
required

Keys of protected fields the contact has filled in; the value only comes from the reveal route

Array<string>
optedOut
required

True when the contact must not receive campaigns, sequences or automations

boolean
blocked
required
object
at
required
string format: date-time
reason
required
string
Allowed values: spam engano sem_interesse duplicado outro
by
required
object
id
required
string
name
required
string
nullable
origin
required
object
id
required
string
name
required
string
color
required
string
nullable
company
required
object
id
required
string
name
required
string
tags
required
Array<object>
object
id
required
string
name
required
string
color
required
string
nullable
profilePicUrl
required

Presigned url for the contact’s whatsapp profile photo

string
nullable
createdAt
required
string format: date-time
openDealsValue
required

Sum (centavos) of the contact’s non-deleted deals in an open-kind stage

number
dealsCount
required

Count of the contact’s non-deleted deals

number
nextCursor
required
string
nullable

Example

{
"items": [
{
"blocked": {
"reason": "spam"
}
}
]
}