Contatos

Listar contatos

GEThttps://api.seudominio.com.br/integrations/v1/contacts

Lista e busca contatos, em ordem alfabética.

Cada contato traz opted_out: true quando ele está descadastrado (não recebe campanhas, sequências nem chatbots automáticos), com a data (opted_out_at, Unix) e a origem (opted_out_source).

Com opted_out=true a lista traz só os descadastrados, dos mais recentes para os mais antigos (25 por página), com opted_out_at e opted_out_source (cliente = pediu na conversa, manual = a equipe, api = integração). Nesse modo, q busca só pelo nome.

Parâmetros de consulta

qstring

Busca por nome, telefone ou e-mail.

pageinteger

Página (15 contatos por página; 25 com opted_out).

Padrão: 1

opted_outboolean

true = só os contatos descadastrados.

Respostas

AnteriorListar canais Próximo Criar contato

Token (Bearer)

Fica só nesta aba do navegador e é usado nos exemplos abaixo.

curl --request GET \
  --url 'https://api.seudominio.com.br/integrations/v1/contacts' \
  --header 'Authorization: Bearer sk_SEU_TOKEN' \
  --header 'Accept: application/json'

Resposta

{
  "contacts": [
    {
      "id": 35,
      "name": "Maria Souza",
      "phone_number": "+5511999990000",
      "email": "maria@email.com",
      "created_at": 1727200000,
      "opted_out": false
    }
  ],
  "total": 1,
  "page": 1
}