Dealboard Auth API

The Auth API from Dealboard — 1 operation(s) for auth.

GitHub OpenAPI

Operations 1

GET /v1/me Verify your API key #

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-auth-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-auth-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Dealboard Auth API
  version: 1.2.0
  contact:
    name: Dealboard
    email: support@getdealboard.com
    url: https://getdealboard.com/developers
  description: 'Operations tagged Auth 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: Auth
paths:
  /v1/me:
    get:
      summary: Verify your API key
      description: Returns the calling user, their workspace, and the key in use. The fastest way to confirm a key works.
      tags:
      - Auth
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Me'
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '429':
          description: Rate limit exceeded.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      operationId: getV1Me
      x-operation-id-source: derived
    servers:
    - url: https://app.getdealboard.com
      description: Production
components:
  schemas:
    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.
    Me:
      type: object
      required:
      - user
      - workspace
      - apiKey
      - auth
      properties:
        user:
          type: object
          required:
          - id
          - email
          - name
          properties:
            id:
              type: string
              format: uuid
            email:
              type: string
              format: email
            name:
              type:
              - string
              - 'null'
        workspace:
          type: object
          required:
          - id
          - name
          - plan
          properties:
            id:
              type: string
              format: uuid
            name:
              type: string
            plan:
              type: string
              enum:
              - free
              - standard
        apiKey:
          type:
          - object
          - 'null'
          description: The API key in use, or null when authenticated via OAuth.
          required:
          - id
          - name
          properties:
            id:
              type: string
              format: uuid
            name:
              type: string
        auth:
          type: object
          description: How the caller authenticated and what it may do.
          required:
          - kind
          - scopes
          - client
          properties:
            kind:
              type: string
              enum:
              - api_key
              - oauth
            scopes:
              type: array
              items:
                type: string
                enum:
                - deals:read
                - deals:write
                - leads:read
                - leads:write
                - pipeline:read
              description: 'Granted scopes. API keys hold the full set (role is the gate); OAuth tokens hold exactly what the user consented to.


                - `deals:read` — List, search, and read deals plus their notes and activity.

                - `deals:write` — Create deals, update fields, move stages, and add notes.

                - `leads:read` — Read inbound leads and their enrichment payloads.

                - `leads:write` — Triage leads, promote them to deals, and write enrichment back.

                - `pipeline:read` — Read pipeline summaries, weighted pipeline, report cards, and export PNGs.'
            client:
              type:
              - object
              - 'null'
              description: The OAuth client, when kind = oauth.
              properties:
                id:
                  type: string
  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)