POST /v1/contacts/search
const url = 'https://seu-endereco-da-api/v1/contacts/search';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"filter":{},"cursor":"example","limit":1}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}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).
Authorizations
Seção intitulada “Authorizations”Request Bodyrequired
Seção intitulada “Request Bodyrequired”object
Condition tree: a group { and | or: node[] } or a leaf { field, op, value }. Fields: name, phoneNumber (eq/neq/contains/startsWith/in), optedOut (eq), attributes.
object
Example generated
{ "filter": {}, "cursor": "example", "limit": 1}Responses
Seção intitulada “Responses”object
object
The caller may edit this contact
Masked to the domain for readers without contacts:read_phone
object
Keys of protected fields the contact has filled in; the value only comes from the reveal route
True when the contact must not receive campaigns, sequences or automations
object
object
object
object
object
Presigned url for the contact’s whatsapp profile photo
Sum (centavos) of the contact’s non-deleted deals in an open-kind stage
Count of the contact’s non-deleted deals
Example
{ "items": [ { "blocked": { "reason": "spam" } } ]}