Dealboard Notes API

The Notes API from Dealboard — 3 operation(s) for notes.

GitHub OpenAPI

Operations 5

GET /v1/deals/{id}/notes List manual notes on a deal #
POST /v1/deals/{id}/notes Add a manual note #
GET /v1/deals/{id}/activity List notes + system events (full activity feed) #
PATCH /v1/notes/{id} Edit a manual note #
DELETE /v1/notes/{id} Delete a manual note #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/dealboard:dealboard-notes-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

dealboard-notes-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Dealboard Notes API
  version: 1.2.0
  contact:
    name: Dealboard
    email: support@getdealboard.com
    url: https://getdealboard.com/developers
  description: 'Operations tagged Notes across 2 of this provider''s published API definitions: openapi.json, dealboard-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://app.getdealboard.com
  description: Production
security:
- BearerApiKey: []
tags:
- name: Notes
paths:
  /v1/deals/{id}/notes:
    parameters:
    - name: id
      in: path
      required: true
      schema:
        type: string
        format: uuid
    get:
      summary: List manual notes on a deal
      tags:
      - Notes
      parameters:
      - name: limit
        in: query
        schema:
          type: integer
          minimum: 1
          maximum: 100
          default: 25
        description: Max number of items per page (1-100).
      - name: cursor
        in: query
        schema:
          type: string
        description: Opaque cursor from a previous response's `nextCursor`.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NoteList'
      operationId: getV1DealsByIdNotes
      x-operation-id-source: derived
    post:
      summary: Add a manual note
      tags:
      - Notes
      parameters:
      - name: Idempotency-Key
        in: header
        schema:
          type: string
        description: Optional client-chosen string. If the same key is sent twice within 24h with the same body, the original response is replayed.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - contentText
              properties:
                contentText:
                  type: string
                  maxLength: 20000
                  description: 'Note body. Markdown is supported and rendered: ## headings, - bullet lists, 1. numbered lists, **bold**, *italic*, [links](https://…). For meeting or call notes, use short headings and bullets. Plain text also works; line breaks are kept.'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Note'
      operationId: postV1DealsByIdNotes
      x-operation-id-source: derived
    servers:
    - url: https://app.getdealboard.com
      description: Production
  /v1/deals/{id}/activity:
    parameters:
    - name: id
      in: path
      required: true
      schema:
        type: string
        format: uuid
    get:
      summary: List notes + system events (full activity feed)
      tags:
      - Notes
      parameters:
      - name: limit
        in: query
        schema:
          type: integer
          minimum: 1
          maximum: 100
          default: 25
        description: Max number of items per page (1-100).
      - name: cursor
        in: query
        schema:
          type: string
        description: Opaque cursor from a previous response's `nextCursor`.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NoteList'
      operationId: getV1DealsByIdActivity
      x-operation-id-source: derived
    servers:
    - url: https://app.getdealboard.com
      description: Production
  /v1/notes/{id}:
    parameters:
    - name: id
      in: path
      required: true
      schema:
        type: string
        format: uuid
    patch:
      summary: Edit a manual note
      description: Only the note's author can edit it — the same rule as the app.
      tags:
      - Notes
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - contentText
              properties:
                contentText:
                  type: string
                  maxLength: 20000
                  description: 'Note body. Markdown is supported and rendered: ## headings, - bullet lists, 1. numbered lists, **bold**, *italic*, [links](https://…). For meeting or call notes, use short headings and bullets. Plain text also works; line breaks are kept.'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Note'
        '403':
          description: You are not the note's author (`not_note_author`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '404':
          description: Note not found in your workspace, or is a system event (not editable).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      operationId: patchV1NotesById
      x-operation-id-source: derived
    delete:
      summary: Delete a manual note
      description: The note's author or a workspace admin can delete it — the same rule as the app. Others get 403 `not_note_author`.
      tags:
      - Notes
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                required:
                - id
                - deleted
                properties:
                  id:
                    type: string
                  deleted:
                    type: boolean
        '404':
          description: Note not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      operationId: deleteV1NotesById
      x-operation-id-source: derived
    servers:
    - url: https://app.getdealboard.com
      description: Production
components:
  schemas:
    NoteList:
      type: object
      required:
      - data
      - hasMore
      - nextCursor
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Note'
        hasMore:
          type: boolean
        nextCursor:
          type:
          - string
          - 'null'
          description: Pass as `?cursor=` on the next request to fetch the next page.
    ErrorEnvelope:
      type: object
      required:
      - error
      properties:
        error:
          type: object
          required:
          - type
          - code
          - message
          - request_id
          properties:
            type:
              type: string
              description: Coarse machine-readable category.
              enum:
              - authentication_error
              - permission_error
              - invalid_request_error
              - not_found
              - rate_limit_error
              - conflict_error
              - unsupported_media_type
              - method_not_allowed
              - api_error
            code:
              type: string
              description: Finer-grained error code.
            message:
              type: string
              description: Human-readable English explanation.
            request_id:
              type: string
              description: The Dealboard-Request-Id assigned to this request. Quote this when filing a bug.
    Note:
      type: object
      required:
      - id
      - dealId
      - authorId
      - kind
      - contentText
      - contentJson
      - systemEventType
      - systemEventData
      - createdAt
      - editedAt
      properties:
        id:
          type: string
          format: uuid
        dealId:
          type: string
          format: uuid
        authorId:
          type: string
          format: uuid
        kind:
          type: string
          enum:
          - manual
          - system_event
        contentText:
          type:
          - string
          - 'null'
        contentJson:
          description: Tiptap document JSON for manual notes; null for system events.
        systemEventType:
          type:
          - string
          - 'null'
        systemEventData: {}
        createdAt:
          type: string
          format: date-time
        editedAt:
          type:
          - string
          - 'null'
          format: date-time
  securitySchemes:
    BearerApiKey:
      type: http
      scheme: bearer
      bearerFormat: dlb_live_<43-char-base62>
      description: API keys are workspace-scoped and inherit the creator's role. Generate in Workspace Settings → API Keys.
    BearerOAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: OAuth 2.1 access token (audience-bound to the /mcp resource). Obtained via the authorization-code + PKCE flow — discovery at /.well-known/oauth-authorization-server. Used by the remote MCP endpoint (/mcp) and accepted on /v1/* as well; effective permission is the granted scopes intersected with the user's workspace role.
x-refined-from:
- openapi.json
- dealboard-openapi.json
x-provenance:
  method: harvested
  publisher: Dealboard
  source: https://app.getdealboard.com/openapi.json
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)