Listar contatos

Devolve os contatos da conta, do mais recente para o mais antigo, em páginas por cursor.

GET https://app.salos.com.br/api/contacts contacts:read

Filtros

Parâmetro Tipo O que faz
search texto procura por nome, e-mail e telefone
company_id uuid só os contatos daquela empresa
external_id texto o contato com esse id do seu sistema (o de-para da importação)
limit número quantos por página (padrão 25, teto 999)
cursor texto o next_cursor da página anterior
format csv devolve CSV em vez de JSON, para planilha
created_after data ISO 8601 completa, com fuso (2026-01-01T00:00:00Z) só contatos criados a partir deste instante
created_before data ISO 8601 só contatos criados até este instante
updated_after data ISO 8601 só contatos atualizados a partir deste instante
updated_before data ISO 8601 só contatos atualizados até este instante

Resposta

{
  "data": [
    {
      "id": "9f1e4b7a-2d5c-4f8e-8b3a-6c9d2e5f1a73",
      "name": "João Silva",
      "email": "joao.silva@exemplo.com.br",
      "phone": "+55 11 98888-0001",
      "title": "Comprador",
      "company_id": null,
      "instagram": null,
      "messenger_id": null,
      "external_id": null,
      "tags": [],
      "custom_fields": {},
      "created_at": "2026-05-02T12:00:00.000Z",
      "updated_at": "2026-05-02T12:00:00.000Z"
    }
  ],
  "pagination": { "next_cursor": null }
}

Enquanto next_cursor vier preenchido, existe mais página. Quando vier null, acabou.

Duas armadilhas

  • O campo tags some se a chave não tiver tags:read. Ele não vem vazio: some do JSON — quem lê contato.tags.length quebra sem entender por quê.
  • Sem cursor, cada chamada devolve a primeira página. Percorrer a base é seguir o next_cursor, nunca somar offset.