Developers
Criar chave de APIEntrar na plataforma

Listar etapas do funil

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

GEThttps://api2.astrify.com.br/v1/funis/{funil_id}/etapas

Escopo: funis:read · Área: Funis · Testar no navegador

Parâmetros de caminho

NomeTipoDescrição
funil_id obrigatóriostringId de funil.

Parâmetros de query

NomeTipoDescrição
incluir_ocultas boolean Padrão: false.

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

Resposta

Status 200, em JSON:

{
"success": true,
"etapas": [
{
"id": "c4b8f2a9-6d17-4e35-b0a2-91f3d85c7e10",
"nome": "Novo Lead",
"ordem": 0,
"ativo": true
}
]
}

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.