Dealboard
O rastreador visual de negócios para agentes de IA pesquisarem pipelines, registrarem notas, qualificarem leads e exportarem relatórios ao vivo.
Documentação
A API do Dealboard. Feita para humanos e agentes de IA.
Leia e escreva negócios, ouça eventos e conecte o Dealboard a ferramentas de IA. Use a API REST, webhooks assinados, especificação OpenAPI ou servidor MCP, dependendo do que você está construindo.
Nota da API v1 (lançamento de maio de 2026): o campo stage nas respostas de negócios agora é um objeto em vez de uma string. O mesmo se aplica a from_stage e to_stage nos payloads de webhook. Atualize as integrações de acordo — veja os exemplos abaixo para o novo formato.
# Your first call — list deals
curl "https://app.getdealboard.com/v1/deals" \
-H "Authorization: Bearer $DEALBOARD_API_KEY"
# Response
{
"data": [
{
"id": "deal_8f3a...",
"company": "Acme Inc.",
"amountCents": 4800000,
"currency": "USD",
"stage": { "id": "stg_abc123", "name": "Proposal Sent", "region": "anchor", "isAnchor": true },
"ownerName": "Alex Chen"
}
],
"next_cursor": null
}
Dois objetos. Um ciclo de vida.
O Dealboard separa o interesse bruto recebido do seu funil de vendas, para que cada um receba a interface e o esquema corretos. Eles se conectam por meio de uma chamada explícita de promoção.
Lead
Interesse bruto recebido.
Criado quando alguém envia o formulário do seu site, sua página de contato hospedada ou envia e-mail para seu endereço de entrada. Contém as informações de contato do remetente, sua mensagem e qualquer enriquecimento que seu qualificador escrever. Fica na caixa de entrada de Leads até você fazer a triagem.
Estados de triagem
new contacted promoted junk bad_fit stale
Negócio
Uma oportunidade real de pipeline.
Tem estágio, responsável, valor, notas, propostas anexadas, contratos e um feed de atividades. Move-se pelas regiões do pipeline do seu quadro (início → âncora → final → ganho/perdido). É isso que aparece nos Relatórios.
Regiões do pipeline
early anchor late won dead
Conectando os dois. Promova um Lead com POST /v1/leads/{lead_id}/promote. A linha do Lead permanece com triage_status: "promoted" e um deal_id apontando para o novo Negócio — você mantém toda a proveniência de entrada para sempre, e a chamada é idempotente, então repetições retornam o id do negócio existente sem criar um segundo.
Mova dados de negócios para dentro, mantenha-os atualizados e envie-os para onde seu time trabalha.
A API do Dealboard cobre os fluxos de trabalho mais importantes: capturar leads, enriquecê-los, promovê-los a negócios, atualizar campos, mover negócios entre estágios, adicionar notas e reagir a eventos.
Ler negócios
Liste, filtre, pesquise e pagine negócios. Busque um único negócio com seu histórico completo de atividades.
GET /v1/deals GET /v1/deals/{deal_id}
Criar negócios
Crie negócios a partir de formulários, fontes de leads, planilhas, ferramentas internas ou outro sistema que seu time já usa.
POST /v1/deals
Atualizar negócios
Altere campos, responsáveis, valores, próximos passos e outros detalhes do negócio.
PATCH /v1/deals/{deal_id}
Mover negócios entre estágios
Mova um negócio para frente e registre a mudança de estágio no feed de atividades.
POST /v1/deals/{deal_id}/move
Listar os estágios de um quadro
Liste os estágios personalizáveis de um quadro. Cada estágio retorna seu id, nome, região, posição e probabilidade.
GET /v1/boards/{board_id}/stages
Adicionar notas
Anexe contexto de ligações, reuniões, follow-ups, importações ou resumos gerados por IA.
POST /v1/deals/{deal_id}/notes
Ler leads
Liste leads recebidos do formulário do seu site, página de contato hospedada ou endereço de e-mail de entrada. Filtre por quadro ou status de triagem — novo, contatado, promovido, lixo, bad_fit, obsoleto.
GET /v1/leads GET /v1/leads/{lead_id}
Criar um lead
Envie leads para o Dealboard servidor-a-servidor — por exemplo, encaminhe o formulário existente do seu site (Gravity Forms, um webhook, código personalizado) para a caixa de entrada. Autenticado pela sua chave de API, então ignora a verificação de bot do navegador. Dispara o webhook lead.created para que um alerta no Slack e qualquer ferramenta de qualificação o capturem.
POST /v1/leads
Enriquecer leads (escrever saída do qualificador)
Aplique um PATCH com um payload de enriquecimento em um lead a partir do seu próprio qualificador — uma pontuação normalizada de 0–100, um veredito, um texto em markdown, uma captura de tela da página inicial, um status assíncrono e um objeto contact\ para a pessoa que você identificou (nome, cargo, e-mail, telefone e uma URL do LinkedIn). Cada PATCH mescla as chaves que você envia e anexa um snapshot de auditoria. A pontuação + veredito aparecem como um selo colorido na caixa de entrada de Leads, e quando o lead é promovido a um negócio, o contato que você encontrou — incluindo sua URL do LinkedIn — flui diretamente para o negócio. Use isso a partir do Claude, GPT, Clearbit, Apollo, Hazel ou um modelo interno.
PATCH /v1/leads/{lead_id}
Fazer triagem de leads
Altere o estado do ciclo de vida de um lead — marque como contatado após uma resposta, marque como lixo para spam, marque como bad_fit quando não for seu cliente. Mantém a caixa de entrada limpa e alimenta a visualização de arquivo.
PATCH /v1/leads/{lead_id}
Promover um lead a negócio (temporariamente desativado)
Atualmente desativado — esta chamada retorna 403 (promote_disabled). Enriqueça leads via API; um colega de equipe os promove a negócios pela caixa de entrada do Dealboard. Quando reativado: transforma um lead recebido em uma oportunidade real de pipeline, criando um negócio no mesmo quadro vinculado de volta à linha do lead para proveniência completa. Idempotente — repetições retornam o id do negócio existente, nunca um segundo.
POST /v1/leads/{lead_id}/promote
Listar modelos de e-mail
Busque os modelos de e-mail do seu workspace (mais usados primeiro) com assunto e corpo, e registre um uso quando um for enviado — mantendo a ordem de mais usados honesta. Alimenta o seletor de respostas no aplicativo e os modelos de composição da extensão Dealboard para Gmail.
GET /v1/templates POST /v1/templates/{id}/use
Corresponder um contato a negócios e leads
Dado um endereço de e-mail, encontre os negócios e leads aos quais ele pertence — correspondência exata com fallback por domínio da empresa. Alimenta a barra lateral da extensão do Gmail; cada resultado vincula diretamente ao negócio ou lead.
GET /v1/match
Incorporar o Dealboard no Gmail
Gere um token de curta duração que a extensão Dealboard para Gmail resgata para mostrar o negócio ou lead correspondente — a visualização real e editável do Dealboard — dentro da barra lateral do Gmail. A sessão incorporada é particionada para o Gmail e revalida a associação ao workspace.
POST /v1/embed-token
Reagir a eventos
Assine eventos de pipeline e leads com webhooks assinados por HMAC (ou aponte um webhook do Slack/Teams/Discord para eles). lead.created dispara no momento em que um lead chega — conecte-o a um alerta no Slack ou a um bot de qualificação.
deal.created deal.stage_changed deal.won lead.created
Do zero à primeira chamada em minutos.
Crie uma chave. Faça sua primeira solicitação. Mova um negócio.
Etapa 01
Crie uma chave.
Entre em app.getdealboard.com, depois abra Configurações → Chaves de API e clique em Criar chave. A chave completa é mostrada uma vez — copie-a imediatamente. Nomeie-a pelo que ela alimenta para que você possa revogar apenas aquela depois. Workspaces gratuitos têm 2 chaves; planos pagos são ilimitados.
Etapa 02
Faça sua primeira chamada.
Acesse GET /v1/deals para confirmar que sua chave funciona. Ela retorna os negócios no seu workspace.
Etapa 03
Crie ou atualize um negócio.
Envie um POST para /v1/deals, adicione uma nota ou mova um negócio para um novo estágio. Use chaves de idempotência ao repetir solicitações de criação.
# Create a deal
curl "https://app.getdealboard.com/v1/deals" \
-X POST \
-H "Authorization: Bearer $DEALBOARD_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: 4a92-init-import" \
-d '{
"boardId": "board_8f3a...",
"name": "Acme — Series B platform",
"company": "Acme Inc.",
"amountCents": 4800000,
"stageId": "stg_abc123"
}'
# Find a deal by name or company (case-insensitive). Add status=all to include won/dead.
curl "https://app.getdealboard.com/v1/deals?q=acme&status=all" \
-H "Authorization: Bearer $DEALBOARD_API_KEY"
# Has this company ever come in as a lead? Matches company, website, email, and name.
curl "https://app.getdealboard.com/v1/leads?q=acme.com" \
-H "Authorization: Bearer $DEALBOARD_API_KEY"
Qualifique um lead recebido com IA
Assine lead.created, pontue o lead com seu próprio modelo ou ferramenta e aplique um PATCH com o resultado de volta. Sua pontuação + veredito aparecem como um selo colorido na caixa de entrada; seu texto em markdown e a captura de tela do site aparecem no detalhe do lead; e o contact que você identificou — incluindo o LinkedIn — flui para o negócio quando o lead é promovido.
# 1. A new lead just landed (via lead.created webhook or GET /v1/leads?view=active).
# 2. Write your qualifier's output back onto it:
curl "https://app.getdealboard.com/v1/leads/lead_7c2f..." \
-X PATCH \
-H "Authorization: Bearer $DEALBOARD_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"enrichment": {
"status": "complete",
"score": 82, # normalized 0–100 (drives badge color + sort)
"scoreDisplay": "8/10", # how you show it
"verdict": "Reach out to learn more",
"body": "**Strong fit.** Series B telehealth co...\n\n✅ Green flags:\n- 50-state prescribing matches our offering",
"screenshot": "https://img.example.com/acme-home.png",
"provider": "your-qualifier",
"contact": { # the person you resolved — gap-fills the deal on promote
"name": "Dana Smith",
"title": "VP of Product",
"email": "dana@acme.io",
"linkedin": "https://www.linkedin.com/in/dana-smith"
}
}
}'
# 3. When the lead is promoted, the deal inherits the contact —
# including the LinkedIn URL — automatically.
curl "https://app.getdealboard.com/v1/leads/lead_7c2f.../promote" \
-X POST -H "Authorization: Bearer $DEALBOARD_API_KEY"
Conecte agentes de IA aos seus dados de negócios.
O Dealboard dá às ferramentas de IA maneiras estruturadas de ler negócios, adicionar notas, mover negócios, pesquisar histórico de negócios e extrair resumos do quadro sem raspar telas ou adivinhar como o aplicativo funciona.
Servidor MCP
@dealboard/mcp
Use com Claude, Cursor e qualquer cliente compatível com MCP.
npx -y --package=@dealboard/mcp dealboard-mcp
Ações disponíveis
list_deals get_deal create_deal update_deal move_deal add_note search_deals get_pipeline_summary get_weighted_pipeline list_leads search_leads get_lead create_lead patch_lead_enrichment triage_lead promote_lead
Somente /mcp remoto — cartões interativos
Ferramentas autenticadas por OAuth que renderizam cartões de relatório do Dealboard inline em hosts de aplicativos MCP (ChatGPT, Claude) — e retornam os números subjacentes para que o assistente possa responder perguntas de acompanhamento.
show_dealboard_summary show_this_month show_deals_won show_deal_progress
Somente /mcp remoto — exportação de imagem de relatório
Retorne um PNG da superfície exata do aplicativo (a mesma imagem que o "Salvar como PNG" do aplicativo exporta), pronto para postar no Slack, e-mail ou apresentações. Uma ferramenta, parametrizada por relatório.
export_report_image
Especificação OpenAPI 3.1
Use a especificação OpenAPI com ChatGPT Actions, ferramentas de geração de código, agentes internos ou fluxos de trabalho personalizados.
app.getdealboard.com/openapi.json
Referência completa da API
Cada endpoint, parâmetro, formato de solicitação/resposta e código de erro — renderizado interativamente a partir da especificação OpenAPI 3.1.
Navegue pela referência da API
Feito para
Claude DesktopClaude CodeCursorWindsurfChatGPT ActionsOpenAI CodexExtensões MCP do VS Code
Webhooks que mantêm seus outros sistemas atualizados.
Assine mudanças em negócios e o Dealboard enviará um POST JSON assinado para seu endpoint. Cada payload inclui uma assinatura HMAC para que seu sistema possa verificar de onde veio.
Eventos
deal.createddeal.stage_changeddeal.wonlead.created
# Example payload (deal.stage_changed)
{
"event": "deal.stage_changed",
"deal_id": "deal_8f3a...",
"from_stage": { "id": "stg_def456", "name": "In Discussion", "region": "early" },
"to_stage": { "id": "stg_abc123", "name": "Proposal Sent", "region": "anchor" },
"changed_by": "alex@example.com",
"changed_at": "2026-05-20T18:42:00Z"
}
# Headers
X-Dealboard-Signature: sha256=...
Feito para integrações seguras.
Autenticação por token Bearer, solicitações de API somente HTTPS, limites de taxa por chave, acesso isolado por workspace, revogação de chave com um clique e criptografia em repouso para dados e arquivos de clientes.
- Dados e arquivos de clientes são criptografados em repouso
- Chaves de API são hash antes do armazenamento
- Webhooks incluem assinaturas HMAC para verificação
- Chaves de API podem ser revogadas a qualquer momento
- Limites de taxa se aplicam por chave
- O acesso ao workspace é isolado por design