API v1 · Public Beta

The Dealboard API.
Built for humans and AI agents.

Read and write deals, listen for events, and let your AI assistant manage your pipeline. One clean REST API, signed webhooks, and a one-click MCP server.

Get an API key → See the quickstart

your_first_call.sh

# List the deals in your pipeline
curl https://app.getdealboard.com/v1/deals \
  -H "Authorization: Bearer dlb_live_••••••••••••"

{
  "data": [
    {
      "id": "7a9c3b1e-d4f0-4a8d-9f0a-c1b3e2a4f5d6",
      "name": "Riverbend Foods - Annual contract",
      "amountCents": 48000000,
      "currency": "USD",
      "stage": "Proposal Sent",
      "owner": { "id": "…", "name": "Sarah K." },
      "updatedAt": "2026-05-19T14:23:11Z"
    }
  ],
  "hasMore": true,
  "nextCursor": "eyJpZCI6IjdhOWMzYjFlIn0"
}

/v1/* primitives

A small, focused API that does the obvious things.

List, push, move, summarize. Signed webhooks for real-time. Eight MCP tools for AI agents. The whole thing fits in an LLM's context window.

{ }

Read your pipeline

List, filter, search, and paginate deals. Hydrate one deal with its full activity log.

GET /v1/deals · /v1/deals/:id

Push deals in

Create deals from leads, forms, exports, or AI assistants. Idempotency-Key supported.

POST /v1/deals

↻

Move and update

Patch fields and move cards across stages. Every change writes to the activity log.

PATCH /v1/deals/:id · POST /move

⚡

React to events

HMAC-signed webhooks for deal.created, stage_changed, and more.

POST /v1/webhooks

Quickstart

From zero to first call.

Three steps. Two minutes. Anyone in your workspace can do it.

01.

Create a key.

In the app, open Workspace Settings → API Keys and click Create key. Give it a descriptive name like "Zapier sync" so you'll know which to revoke later.

dlb_live_8fH3qZv2nP4xL7wRkY9mB1cT6dJ0sN5aXeF8gU2pHkQ

Copy this once - we only store a hash. Keys inherit the creator's role.

02.

Make your first call.

Hit /v1/me to confirm your key works. It returns the calling user and workspace - no parameters needed.

verify.sh

curl https://app.getdealboard.com/v1/me \
  -H "Authorization: Bearer dlb_live_••••••••"

{
  "user":      { "id": "6a1f…", "name": "Sarah Kim", "role": "admin" },
  "workspace": { "id": "f3e2…", "name": "Acme Sales", "plan": "team" }
}

03.

Push a deal in.

POST to /v1/deals. Only boardId and name are required. Send Idempotency-Key so retries do not double-create.

create_deal.sh

curl -X POST https://app.getdealboard.com/v1/deals \
  -H "Authorization: Bearer dlb_live_••••••••" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: order-9182-create" \
  -d '{
    "boardId": "f3e2d1c0-9b8a-7f6e-5d4c-3b2a1f0e9d8c",
    "name": "Globex - pilot expansion",
    "amountCents": 4500000,
    "currency": "USD",
    "stage": "in_discussion"
  }'

Three conventions to know. Money is in cents (amountCents + currency) - no floats. Timestamps are ISO 8601 in UTC (2026-05-19T14:23:11Z) - never Unix. IDs are raw UUIDs - the same ones you would see in the URL of the deal modal.

Made for AI agents, too.

MCP · OpenAPI · llms.txt

We assume the next reader of our docs might be an AI agent. The API is small enough for an LLM to hold in its head, errors are written in plain English, and the spec is published as a machine-readable file - so any AI tool can build a client in seconds.

Open protocol

MCP server

Works in any MCP-compatible client. One config block, eight tools ready: list, search, create, move, add notes, summarize pipeline.

npx @dealboard/mcp

Machine-readable

OpenAPI 3.1 spec

For tools that do not speak MCP - ChatGPT Actions, code-gen, custom agents. Point and import.

app.getdealboard.com/openapi.json

Agent-friendly

llms.txt

A single file at the root telling AI crawlers where the docs, spec, and MCP server live.

getdealboard.com/llms.txt

Tested with

Claude Desktop Claude Code Cursor Windsurf ChatGPT (Custom GPT) OpenAI Codex VS Code (MCP ext.) Continue Cline

Webhooks that do not lose events.

Subscribe to changes in your pipeline. Every payload is HMAC-signed so you can trust it came from us.

deal.created — new card lands on a board
deal.stage_changed — moved between stages
deal.won — closed in the win column

Webhook reference →

Built with your data in mind.

Bearer-token auth, HTTPS-only, per-key rate limits, and every request is workspace-isolated. Revoke any key with one click.

Keys are SHA-256 hashed in the database
Cross-workspace access is impossible by design
GitHub secret scanning auto-revokes leaked keys

Security details →

Ready to ship something?

Create a key from your workspace settings, then try the 2-minute quickstart.

Get an API key → Quickstart

The Dealboard API.Built for humans and AI agents.