Skip to main content
GET
Search Contacts

Autorizações

api_access_token
string
header
obrigatório

Este token pode ser obtido visitando a página de perfil ou por meio do console rails. Fornece acesso a endpoints com base nos níveis de permissões do usuário. Este token pode ser salvo por um sistema externo quando o usuário é criado via API, para realizar atividades em nome do usuário.

Parâmetros de caminho

account_id
integer
obrigatório

O ID numérico da conta

Parâmetros de consulta

q
string

Pesquise usando name, identifier, email ou phone number do contato

sort
enum<string>

O atributo pelo qual a lista deve ser ordenada

Opções disponíveis:
name,
email,
phone_number,
last_activity_at,
-name,
-email,
-phone_number,
-last_activity_at
page
integer
padrão:1

O parâmetro da página

Resposta

Sucesso

meta
object
payload
object[]

Lista de contatos