API v1 · Generally available

The Dealboard API. Built for humans and AI agents.

Read and write deals, listen for events, and connect Dealboard to AI tools. Use the REST API, signed webhooks, OpenAPI spec, or MCP server depending on what you’re building.

Get an API key See the quickstart

# 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.",
      "amount": 48000,
      "stage": "Proposal Sent",
      "owner": "alex@..."
    }
  ],
  "next_cursor": null
}

Move deal data in, keep it current, and send it where your team works.

Dealboard’s API covers the workflows that matter most: creating deals, updating fields, moving deals through stages, adding notes, pulling summaries, and reacting to deal events.

Read deals

List, filter, search, and paginate deals. Fetch a single deal with its full activity history.

GET /v1/dealsGET /v1/deals/{deal_id}

Create deals

Create deals from forms, lead sources, spreadsheets, internal tools, or another system your team already uses.

POST /v1/deals

Update deals

Change fields, owners, amounts, next steps, and other deal details.

PATCH /v1/deals/{deal_id}

Move deals through stages

Move a deal forward and write the stage change to the activity feed.

POST /v1/deals/{deal_id}/move

Add notes

Attach context from calls, meetings, follow-ups, imports, or AI-generated summaries.

POST /v1/deals/{deal_id}/notes

React to events

Subscribe to important deal events with HMAC-signed webhooks.

deal.createddeal.updateddeal.stage_changeddeal.wonnote.added

From zero to first call in minutes.

Create a key. Make your first request. Move a deal.

Step 01

Create a key.

In Dealboard, open Account Settings → API Keys and create a new key. Give it a clear name so you know what it powers and can revoke it later.

Step 02

Make your first call.

Hit GET /v1/deals to confirm your key works. It returns the deals in your workspace.

Step 03

Create or update a deal.

Post to /v1/deals, add a note, or move a deal to a new stage. Use idempotency keys when retrying create requests.

# 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 '{
    "company": "Acme Inc.",
    "amount": 48000,
    "stage": "Meeting Scheduled",
    "owner_email": "alex@example.com"
  }'

Connect AI agents to your deal data.

Dealboard gives AI tools structured ways to read deals, add notes, move deals, search deal history, and pull dealboard summaries without scraping screens or guessing how the app works.

MCP server

@dealboard/mcp

Use with Claude, Cursor, and any MCP-compatible client.

npx -y --package=@dealboard/mcp dealboard-mcp

Available actions

list_dealsget_dealcreate_dealupdate_dealmove_dealadd_notesearch_dealsget_pipeline_summary

OpenAPI 3.1 spec

Use the OpenAPI spec with ChatGPT Actions, code-generation tools, internal agents, or custom workflows.

app.getdealboard.com/openapi.json

Full API reference

The OpenAPI 3.1 spec is the complete API reference — all endpoints, parameters, request/response shapes, and error codes.

app.getdealboard.com/openapi.json

Designed for

Claude DesktopClaude CodeCursorWindsurfChatGPT ActionsOpenAI CodexVS Code MCP extensions

Webhooks that keep your other systems current.

Subscribe to deal changes and Dealboard will send a signed JSON POST to your endpoint. Every payload includes an HMAC signature so your system can verify where it came from.

Events

deal.created
deal.updated
deal.stage_changed
deal.won
deal.dead
note.added
owner.changed

# Example payload (deal.stage_changed)
{
  "event": "deal.stage_changed",
  "deal_id": "deal_8f3a...",
  "from_stage": "In Discussion",
  "to_stage": "Proposal Sent",
  "changed_by": "alex@example.com",
  "changed_at": "2026-05-20T18:42:00Z"
}

# Headers
X-Dealboard-Signature: sha256=...

Built for secure integrations.

Bearer-token authentication, HTTPS-only API requests, per-key rate limits, workspace-isolated access, one-click key revocation, and encryption at rest for customer data and files.

Customer data and files are encrypted at rest
API keys are hashed before storage
Webhooks include HMAC signatures for verification
API keys can be revoked anytime
Rate limits apply per key
Workspace access is isolated by design

Start building with Dealboard.

Create an API key, run the quickstart, and connect deals, notes, webhooks, and AI agents.

Get an API key Get Started Free