Pular para o conteúdo

POST /v1/contacts/search

POST
/v1/contacts/search
curl --request POST \
--url https://seu-endereco-da-api/v1/contacts/search \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "filter": {}, "cursor": "example", "limit": 1 }'

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

Media typeapplication/json
object
filter

Condition tree: a group { and | or: node[] } or a leaf { field, op, value }. Fields: name, phoneNumber (eq/neq/contains/startsWith/in), optedOut (eq), attributes. (eq/neq/contains/in/exists/gt/gte/lt/lte; on a date field also before/after/between by year, and dayMonthEq/dayMonthBetween taking –MM-DD, which match a date stored with or without a year), createdAt (before/after/between), tags (hasAny/hasAll/hasNone), negocio.pipeline | negocio.etapa (eq/neq/in/notIn/isNull/notNull) and negocio.valor (eq/neq/gt/gte/lt/lte/between/notBetween/isNull/notNull) on the contact’s latest open deal, negocio.status (eq/neq/in/notIn/isNull/notNull) on the contact’s latest deal whatever its outcome, negocio.parado (eq) when that open deal sat in its stage longer than the stage’s staleDays.

object
cursor
string
nullable
limit
integer
>= 1 <= 200

Example generated

{
"filter": {},
"cursor": "example",
"limit": 1
}
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"
}
}
]
}