Developers
Criar chave de APIEntrar na plataforma

Listar contatos

Rota de Contatos da API aberta da Astrify Flows: parâmetros, exemplos em curl, Node.js e Python, resposta e erros.

GEThttps://api2.astrify.com.br/v1/contatos

Escopo: contatos:read · Área: Contatos · Testar no navegador

Parâmetros de query

NomeTipoDescrição
busca string—
etiqueta string—
carteira string—
limit integerQuantos itens por página. O padrão e o máximo mudam por rota (veja Paginação e filtros). Padrão: 50.
offset integerQuantos itens pular. Padrão: 0.

Exemplo de requisição

A chave vem da variável de ambiente ASTRIFY_API_KEY. Troque os marcadores em maiúsculas (comoLEAD_ID) por ids da sua empresa.

Terminal window
curl "https://api2.astrify.com.br/v1/contatos" \
-H "Authorization: Bearer $ASTRIFY_API_KEY"
const res = await fetch('https://api2.astrify.com.br/v1/contatos', {
headers: {
Authorization: `Bearer ${process.env.ASTRIFY_API_KEY}`,
},
});
console.log(res.status, await res.json());
import os, requests
r = requests.get(
"https://api2.astrify.com.br/v1/contatos",
headers={"Authorization": f"Bearer {os.environ['ASTRIFY_API_KEY']}"},
timeout=20,
)
print(r.status_code, r.json())

Resposta

Status 200, em JSON:

{
"success": true,
"contatos": [
{
"id": "3f9c2b1e-8a4d-4c71-9e0b-5d2a7c6f1b34",
"nome": "Ana",
"sobrenome": "Souza",
"whatsapp": "5541999990000",
"email": "ana@exemplo.com",
"etiquetas": [
"cliente"
],
"cpf_cnpj": null,
"campos_customizados": {},
"created_at": "2026-10-01T14:32:10.123456+00:00",
"updated_at": "2026-10-01T14:32:10.123456+00:00"
}
],
"total": 1,
"has_more": false
}

Erros

StatusQuando acontece
401Chave ausente, inválida, expirada ou revogada.
403Sem o escopo exigido, cargo sem permissão, IP não autorizado ou registro de outra empresa.
422Corpo ou parâmetro com formato inválido. O detail lista os campos com problema.
429Limite de 120 requisições por minuto da chave. Espere o tempo do cabeçalho Retry-After.

O formato dos erros e as retentativas estão em Limites de uso e erros.

Digite para pesquisar em toda a documentação.