Conecte seu sistema à Astrify Flows
A API REST em JSON e os webhooks da plataforma. Crie leads, mova cards, envie mensagens pelo WhatsApp e dispare Workflows a partir do seu ERP, site ou loja.
128 operações, especificação OpenAPI 3.1.0 e coleção do Postman para baixar.
curl https://api2.astrify.com.br/v1/me \
-H "Authorization: Bearer $ASTRIFY_API_KEY"const res = await fetch('https://api2.astrify.com.br/v1/me', {
headers: { Authorization: `Bearer ${process.env.ASTRIFY_API_KEY}` },
});
console.log(await res.json());import os, requests
r = requests.get(
"https://api2.astrify.com.br/v1/me",
headers={"Authorization": f"Bearer {os.environ['ASTRIFY_API_KEY']}"},
)
print(r.json())200 Resposta de GET /v1/me
{
"data": {
"empresa_id": "00000000-0000-0000-0000-000000000000",
"chave": {
"nome": "Integração com o ERP",
"escopos": ["contatos:write", "leads:write"],
"expira_em": "2027-11-15T12:00:00+00:00",
"limite_rpm": 120
}
}
}128 operações em 17 áreas
As mesmas áreas que a sua equipe usa na plataforma. Escolha uma área e clique numa rota para ver o escopo, os parâmetros, o corpo, exemplos em curl, Node.js e Python e a resposta.
Quadros
Ver as rotas de Quadros- GET
/v1/quadrosListar quadros - GET
/v1/quadros/anexos/urlListar url - POST
/v1/quadros/anexos/urlsCriar urls - DELETE
/v1/quadros/anexos/{anexo_id}Excluir anexos - DELETE
/v1/quadros/campos-customizados/{campo_id}Excluir campos customizados - GET
/v1/quadros/cards/arquivadosListar arquivados - PATCH
/v1/quadros/cards/reordenarReordenar cards - PATCH
/v1/quadros/cards/{card_id}Atualizar card - DELETE
/v1/quadros/cards/{card_id}Excluir cards - POST
/v1/quadros/cards/{card_id}/anexosCriar anexos - GET
/v1/quadros/cards/{card_id}/atividadesListar atividades - POST
/v1/quadros/cards/{card_id}/checklistsCriar checklists - POST
/v1/quadros/cards/{card_id}/comentariosCriar comentarios - PATCH
/v1/quadros/cards/{card_id}/concluirConcluir/reabrir card - GET
/v1/quadros/cards/{card_id}/detalhesDetalhar cards - POST
/v1/quadros/cards/{card_id}/duplicarDuplicar cards - POST
/v1/quadros/cards/{card_id}/etiquetas/{etiqueta_id}Adicionar etiqueta ao card - DELETE
/v1/quadros/cards/{card_id}/etiquetas/{etiqueta_id}Remover etiqueta do card - POST
/v1/quadros/cards/{card_id}/moverMover card de coluna - POST
/v1/quadros/cards/{card_id}/participantesCriar participantes - DELETE
/v1/quadros/cards/{card_id}/participantes/{usuario_alvo_id}Excluir participantes - PATCH
/v1/quadros/checklist-itens/{item_id}Atualizar checklist itens - DELETE
/v1/quadros/checklist-itens/{item_id}Excluir checklist itens - POST
/v1/quadros/checklist-itens/{item_id}/responsaveisCriar responsaveis - DELETE
/v1/quadros/checklist-itens/{item_id}/responsaveis/{usuario_alvo_id}Excluir responsaveis - DELETE
/v1/quadros/checklists/{checklist_id}Excluir checklists - POST
/v1/quadros/checklists/{checklist_id}/itensCriar itens - PATCH
/v1/quadros/colunas/{coluna_id}Atualizar colunas - DELETE
/v1/quadros/colunas/{coluna_id}Excluir colunas - POST
/v1/quadros/colunas/{coluna_id}/cardsCriar card - DELETE
/v1/quadros/comentarios/{comentario_id}Excluir comentarios - POST
/v1/quadros/criarCriar quadro - DELETE
/v1/quadros/membros/{membro_id}Excluir membros - GET
/v1/quadros/meus-cards-pendentesListar meus cards pendentes - PATCH
/v1/quadros/{quadro_id}Atualizar quadros - GET
/v1/quadros/{quadro_id}/campos-customizadosListar campos customizados - POST
/v1/quadros/{quadro_id}/campos-customizadosCriar campos customizados - POST
/v1/quadros/{quadro_id}/colunasCriar coluna - POST
/v1/quadros/{quadro_id}/etiquetasCriar etiquetas - GET
/v1/quadros/{quadro_id}/membrosListar membros - POST
/v1/quadros/{quadro_id}/membrosCriar membros
- GET
/v1/campos_customizados/{alvo}Listar campos personalizados (leads ou contatos) - GET
/v1/leadsListar leads - POST
/v1/leadsCriar lead - GET
/v1/leads/detalhes/{lead_id}Detalhar lead - GET
/v1/leads/duplicatasListar leads duplicados - POST
/v1/leads/importar-loteImportar leads em lote - POST
/v1/leads/mesclarMesclar leads - PATCH
/v1/leads/{lead_id}Atualizar lead - DELETE
/v1/leads/{lead_id}Excluir lead - POST
/v1/leads/{lead_id}/atividadeRegistrar atividade no lead - PATCH
/v1/leads/{lead_id}/atividade/{atividade_id}Atualizar atividade - DELETE
/v1/leads/{lead_id}/atividade/{atividade_id}Excluir atividade - GET
/v1/leads/{lead_id}/itensListar produtos do lead - POST
/v1/leads/{lead_id}/itensAdicionar produto ao lead - PATCH
/v1/leads/{lead_id}/itens/{item_id}Atualizar itens - DELETE
/v1/leads/{lead_id}/itens/{item_id}Excluir itens - POST
/v1/leads/{lead_id}/observacaoAdicionar observação ao lead - PATCH
/v1/leads/{lead_id}/observacao/{observacao_id}Atualizar observacao - DELETE
/v1/leads/{lead_id}/observacao/{observacao_id}Excluir observacao - POST
/v1/leads/{lead_id}/participanteAdicionar participante ao lead - DELETE
/v1/leads/{lead_id}/participante/{participante_id}Excluir participante - POST
/v1/leads/{lead_id}/propostasCriar proposta para o lead
Contatos
Ver as rotas de Contatos- GET
/v1/contatosListar contatos - POST
/v1/contatosCriar contato - GET
/v1/contatos/camposListar campos - GET
/v1/contatos/duplicatasListar duplicatas contatos - POST
/v1/contatos/mesclarMesclar contatos - GET
/v1/contatos/{contato_id}Obter contato - PATCH
/v1/contatos/{contato_id}Atualizar contato - DELETE
/v1/contatos/{contato_id}Excluir contato
Mensagens
Ver as rotas de Mensagens- GET
/v1/mensagens-agendadasListar mensagens agendadas - POST
/v1/mensagens-agendadasAgendar mensagem - DELETE
/v1/mensagens-agendadas/{agendamento_id}Cancelar mensagem agendada - GET
/v1/mensagens-rapidasListar mensagens rápidas - POST
/v1/mensagens/whatsapp/midiaEnviar mídia por WhatsApp - POST
/v1/mensagens/whatsapp/textoEnviar texto por WhatsApp - GET
/v1/whatsapp/instanciasListar instâncias de WhatsApp
Propostas
Ver as rotas de Propostas- GET
/v1/propostasListar propostas - GET
/v1/propostas/{proposta_id}Obter propostas - PATCH
/v1/propostas/{proposta_id}Atualizar propostas - POST
/v1/propostas/{proposta_id}/cancelarCancelar propostas - POST
/v1/propostas/{proposta_id}/duplicarDuplicar propostas - POST
/v1/propostas/{proposta_id}/enviarEnviar propostas - GET
/v1/propostas/{proposta_id}/pdfBaixar PDF propostas
- GET
/v1/email/campanhasListar campanhas de e-mail - GET
/v1/email/campanhas/{campanha_id}Obter campanha de e-mail - POST
/v1/email/enviarEnviar e-mail transacional - GET
/v1/email/listasListar listas de e-mail - POST
/v1/email/listasCriar lista de e-mail - POST
/v1/email/listas/{lista_id}/contatosAdicionar contatos à lista (com consentimento)
Equipes
Ver as rotas de EquipesEtiquetas
Ver as rotas de EtiquetasProdutos
Ver as rotas de ProdutosTarefas
Ver as rotas de TarefasCampanhas de WhatsApp
Ver as rotas de Campanhas de WhatsAppConversas
Ver as rotas de ConversasWorkflows
Ver as rotas de WorkflowsNotificações
Ver as rotas de NotificaçõesRelatórios
Ver as rotas de RelatóriosPrefere outra ferramenta? Baixe a especificação OpenAPI ou acoleção do Postman. A API não tem sandbox: uma chamada feita com a sua chave age nos dados reais da sua empresa.
Guias da API
Cada regra da API explicada uma vez: como a chave funciona, quanto dá para chamar por minuto, como paginar e como receber eventos com segurança.
Ler os primeiros passos- Primeiros passosO que a API aberta da Astrify Flows faz, como conseguir uma chave e como fazer a primeira requisição em poucos minutos.
- Autenticação e chaves de APIComo a chave de API da Astrify Flows funciona, quais escopos existem, validade, IPs permitidos, rotação e registro de uso.
- Limites de uso e errosO limite de 120 requisições por minuto por chave, o cabeçalho Retry-After e o significado de cada status HTTP da API aberta.
- Paginação e filtrosComo percorrer as listas da API aberta da Astrify Flows com limit e offset e quais filtros cada listagem aceita.
- Webhooks de entradaInicie um Workflow da Astrify Flows a partir de qualquer sistema com o gatilho Receber webhook, modo escuta e exemplo de JSON.
- Webhooks de saídaReceba eventos de e-mail marketing da Astrify Flows assinados com HMAC e envie outros dados com o bloco Disparar webhook do Workflow.
- Integração com n8n, Make e ZapierConecte a Astrify Flows ao n8n, ao Make e ao Zapier pelos dois sentidos, com webhook de entrada, Disparar webhook, Requisição HTTP e a API aberta.
- Referência da APITodas as rotas da API aberta da Astrify Flows, com a especificação OpenAPI 3.1 e a coleção do Postman para baixar.
O que mudou na API
As últimas mudanças da plataforma que interessam a quem integra, versão a versão.
Ver o changelog completo- 09/11/2026
Adicionados avisos na tela quando algo impede a loja de funcionar, como aviso de pedido desligado, chave sem permissão, loja sem resposta ou importação que falhou
Novidade · versão 1.0.9.76 · E-commerce
- 04/11/2026
Adicionada a tradução do restante da plataforma nos 16 idiomas: Configurações, Canais, Usuários, Atendimento, Workflows, Agentes de IA, Discord Hub, E-commerce, Políticas e Documentação da API
Novidade · versão 1.0.9.66 · Idiomas
- 28/10/2026
Melhorado: a API segue o cargo de quem criou a chave em contatos, tarefas, canais, campanhas, workflows e e-mail marketing
Melhoria · versão 1.0.9.46 · API aberta
- 27/10/2026
Adicionada a troca do token do bot do Discord na edição do canal, sem precisar criar o canal de novo
Novidade · versão 1.0.9.42 · Canais
- 24/10/2026
Melhorada a página de Documentação da API, com downloads em Mais opções e busca no padrão da plataforma
Melhoria · versão 1.0.9.37 · Documentação
- 22/10/2026
Melhorada a integração com n8n, que agora fica como credencial para usar nos Workflows
Melhoria · versão 1.0.9.12 · Integrações
Crie a sua primeira chave de API
Em Configurações → API aberta, nos planos Growth, Pro e Scale. Escolha os escopos, a validade e os IPs permitidos.