Developers
Criar chave de APIEntrar na plataforma

Listar leads

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

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

Escopo: leads:read · Área: Leads · Testar no navegador

limit/offset paginam. search busca por nome, e-mail, telefone e empresa. tags aceita lista separada por vírgula.

Parâmetros de query

NomeTipoDescrição
view stringVisão da lista. Use list para paginar com limit, offset e total.
funil_id string—
status string—
etapa_id string—
temperatura string—
origem string—
responsavel_id string—
valor_min string—
valor_max string—
data_inicio stringData inicial, AAAA-MM-DD.
data_fim stringData final, AAAA-MM-DD.
tags stringEtiquetas, separadas por vírgula.
contato_id string—
search stringBusca por nome, e-mail, telefone e empresa.
ids string—
limit stringQuantos itens por página. O padrão e o máximo mudam por rota (veja Paginação e filtros).
offset stringQuantos itens pular.

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/leads" \
-H "Authorization: Bearer $ASTRIFY_API_KEY"
const res = await fetch('https://api2.astrify.com.br/v1/leads', {
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/leads",
headers={"Authorization": f"Bearer {os.environ['ASTRIFY_API_KEY']}"},
timeout=20,
)
print(r.status_code, r.json())

Resposta

Status 200, em JSON:

{
"success": true,
"leads": [
{
"id": "3f9c2b1e-8a4d-4c71-9e0b-5d2a7c6f1b34",
"nome": "Ana Souza",
"email": "ana@exemplo.com",
"telefone": "5541999990000",
"empresa": "Souza Ltda",
"valor_estimado": 4500,
"temperatura": "morno",
"status": "aberto",
"funil_id": "b2e6a4d8-1c53-47f9-a8e0-3d7c5b91f402",
"etapa_id": "c4b8f2a9-6d17-4e35-b0a2-91f3d85c7e10",
"responsavel_id": "a1d7e5c0-2b93-4f68-8c15-7e4b9d03f2a6",
"tags": [
"site"
],
"origem": "Site",
"created_at": "2026-10-01T14:32:10.123456+00:00",
"updated_at": "2026-10-01T14:32:10.123456+00:00"
}
],
"total": 1
}

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.