GET /v1/contacts
GET
/v1/contacts
const url = 'https://seu-endereco-da-api/v1/contacts';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}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).
Authorizations
Seção intitulada “Authorizations”Parameters
Seção intitulada “Parameters”Query Parameters
Seção intitulada “Query Parameters”cursor
string
Opaque pagination cursor
limit
string
Page size (default 50, max 200)
Responses
Seção intitulada “Responses”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
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
by
required
object
id
required
string
name
required
string
origin
required
object
id
required
string
name
required
string
color
required
string
company
required
object
id
required
string
name
required
string
tags
required
Array<object>
object
id
required
string
name
required
string
color
required
string
profilePicUrl
required
Presigned url for the contact’s whatsapp profile photo
string
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
Example
{ "items": [ { "blocked": { "reason": "spam" } } ]}