Formo Boards API

openapi: 3.2.0
info:
  title: Formo Public Boards API
  description: 'REST API for managing Formo projects, analytics, alerts, boards, charts, contracts, segments, and AI chat.


    **Auth.** Every endpoint on `api.formo.so` requires a workspace API key with the appropriate scopes (see `x-api-scopes`). The one exception is `POST /v0/raw_events`, which runs on `events.formo.so` and authenticates with the project SDK write key instead.


    **Response shape.** Successful responses return the resource directly (or `{ data: [...], total, page, size, has_more }` for paginated lists). HTTP status carries success/failure; there is no envelope wrapping success bodies.


    **Errors.** Non-2xx responses from `api.formo.so` use the `Error` envelope, with two exceptions: some rate-limit rejections reply in plain text, and `POST /v0/raw_events` returns a plain `{ "error": "..." }` object. Treat the HTTP status as authoritative and parse defensively: `{ error: { code, message, doc_url, param?, details? } }`. Branch on the machine-readable `code` (see `ErrorCode` enum) and follow `doc_url` to the matching section of the errors reference.


    **Idempotency.** Pass an `Idempotency-Key` header on write requests to alerts, boards, charts, contracts, segments, and import to make retries safe; the response is cached for 24 h and replayed on duplicate keys. Profile writes and `POST /v0/query` do not support it.'
  version: 0.1.0
  contact:
    name: Formo
    url: https://formo.so
servers:
- url: https://api.formo.so
  description: API Server (boards, alerts, contracts, segments, profiles, query, import)
- url: https://events.formo.so
  description: Events Server (event ingestion)
security:
- WorkspaceApiKey: []
tags:
- name: Boards
  description: Manage dashboard boards
paths:
  /v0/boards:
    get:
      operationId: listBoards
      summary: List boards
      description: List boards for the project scoped to the API key. Paginated.
      tags:
      - Boards
      parameters:
      - $ref: '#/components/parameters/Page'
      - $ref: '#/components/parameters/Size'
      responses:
        '200':
          description: Paginated list of boards
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/PaginatedListMeta'
                - type: object
                  required:
                  - data
                  properties:
                    data:
                      type: array
                      items:
                        $ref: '#/components/schemas/Board'
              example:
                data:
                - id: brd_a1b2c3d4e5f6
                  project_id: proj_abc123
                  title: Revenue Dashboard
                  description: Weekly revenue, conversion, and retention metrics.
                  enabled: false
                  created_at: '2026-03-04T11:22:08.000Z'
                  updated_at: '2026-04-22T08:14:31.000Z'
                - id: brd_g7h8i9j0k1l2
                  project_id: proj_abc123
                  title: Marketing Funnel
                  description: Acquisition channel performance.
                  enabled: true
                  created_at: '2026-02-18T16:09:44.000Z'
                  updated_at: '2026-04-19T10:55:02.000Z'
                page: 1
                size: 100
                total: 2
                has_more: false
      x-required-scope: boards:read
    post:
      operationId: createBoard
      summary: Create board
      description: Create a new board with the given title.
      tags:
      - Boards
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - title
              properties:
                title:
                  type: string
                  minLength: 1
                  description: Human-readable board name. Required.
                description:
                  type: string
                  description: Optional longer description.
                isPublic:
                  type: boolean
                  description: Whether the board is publicly viewable via its share URL. Defaults to false.
                  default: false
            example:
              title: Weekly KPIs
              description: Headline metrics for the team standup.
              isPublic: false
      responses:
        '201':
          description: Board created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Board'
        '400':
          $ref: '#/components/responses/BadRequest'
        '409':
          $ref: '#/components/responses/Conflict'
      x-required-scope: boards:write
      parameters:
      - $ref: '#/components/parameters/IdempotencyKey'
  /v0/boards/{boardId}:
    get:
      operationId: getBoard
      summary: Get board
      tags:
      - Boards
      parameters:
      - name: boardId
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Board details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Board'
              example:
                id: brd_a1b2c3d4e5f6
                project_id: proj_abc123
                title: Revenue Dashboard
                description: Weekly revenue, conversion, and retention metrics.
                enabled: false
                created_at: '2026-03-04T11:22:08.000Z'
                updated_at: '2026-04-22T08:14:31.000Z'
      x-required-scope: boards:read
    patch:
      operationId: updateBoard
      summary: Update board
      tags:
      - Boards
      parameters:
      - name: boardId
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                title:
                  type: string
                description:
                  type: string
                isPublic:
                  type: boolean
                  description: Whether the board is publicly accessible
            examples:
              updateTitle:
                summary: Update board title
                value:
                  title: Weekly Dashboard
              makePublic:
                summary: Make board publicly accessible
                value:
                  isPublic: true
              fullUpdate:
                summary: Update all fields
                value:
                  title: Revenue Dashboard
                  description: Weekly revenue metrics and KPIs
                  isPublic: true
      responses:
        '200':
          description: Board updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Board'
        '400':
          $ref: '#/components/responses/BadRequest'
        '409':
          $ref: '#/components/responses/Conflict'
      x-required-scope: boards:write
      description: Update board title, description, and/or public visibility.
    delete:
      operationId: deleteBoard
      summary: Delete board
      description: Delete a board and all its charts.
      tags:
      - Boards
      parameters:
      - name: boardId
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/IdempotencyKey'
      responses:
        '200':
          description: Board deleted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Board'
        '400':
          $ref: '#/components/responses/BadRequest'
        '409':
          $ref: '#/components/responses/Conflict'
      x-required-scope: boards:write
components:
  schemas:
    Error:
      type: object
      description: Standard error envelope returned by every public API endpoint for any non-2xx response. The HTTP status code carries success/failure; the body provides a machine-readable `code`, a human-readable `message`, and a `doc_url` pointing at the matching section of the docs so agents can fetch context on the fly.
      properties:
        error:
          type: object
          required:
          - code
          - message
          - doc_url
          properties:
            code:
              $ref: '#/components/schemas/ErrorCode'
            message:
              type: string
              description: Human-readable error description. Wording may change between releases, so branch on `code`, not `message`.
            doc_url:
              type: string
              format: uri
              description: Link to the matching section of the errors reference at https://docs.formo.so/api/errors.
            param:
              type: string
              description: When the error pertains to a specific request field, the dotted path to that field (e.g. `body.trigger_filters.0.value`).
            details:
              type: object
              additionalProperties: true
              description: 'Code-specific extra context. For `INVALID_VALIDATION_REQUEST` this is a `{ fieldPath: message }` map of every Zod validation failure.'
      required:
      - error
    Board:
      type: object
      properties:
        id:
          type: string
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
          nullable: true
        project_id:
          type: string
        enabled:
          type: boolean
          description: Whether the board is publicly accessible
        title:
          type: string
        description:
          type: string
          nullable: true
      required:
      - id
      - project_id
      - enabled
    ErrorCode:
      type: string
      description: Stable, enumerated error codes. New codes may be added in any release; clients should treat unknown codes as the closest matching HTTP status family.
      enum:
      - INTERNAL_SERVER_ERROR
      - INVALID_VALIDATION_REQUEST
      - UNAUTHORIZED
      - BAD_REQUEST
      - FORBIDDEN
      - NOT_FOUND
      - CONFLICT
      - INVALID_CHAIN_ID
      - CONTEXT_LIMIT_EXCEEDED
      - SERVICE_UNAVAILABLE
      - TOO_MANY_REQUESTS
      - IDEMPOTENCY_IN_PROGRESS
      - INVALID_IDEMPOTENCY_KEY
    PaginatedListMeta:
      type: object
      description: 'Pagination cursor returned alongside `data` on every paginated list endpoint. Use these to walk pages: `has_more` is true while `page * size < total`. Combine with the matching `Page` and `Size` query parameters to request the next page.'
      required:
      - page
      - size
      - total
      - has_more
      properties:
        page:
          type: integer
          description: 1-indexed page number echoed from the request.
        size:
          type: integer
          description: Page size echoed from the request.
        total:
          type: integer
          description: Total row count across all pages.
        has_more:
          type: boolean
          description: True when more pages remain (`page * size < total`).
  parameters:
    Size:
      name: size
      in: query
      required: false
      schema:
        type: integer
        minimum: 1
        maximum: 200
        default: 100
      description: Page size. Defaults to 100, capped at 200.
    Page:
      name: page
      in: query
      required: false
      schema:
        type: integer
        minimum: 1
        default: 1
      description: 1-indexed page number. Defaults to 1.
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: false
      schema:
        type: string
        maxLength: 255
      description: Optional unique value (e.g. a UUID v4) that lets you safely retry POST/PUT/PATCH/DELETE requests. The first request runs normally; subsequent requests with the same key replay the stored response (status + body) for 24 hours, so retries can never double-create or double-charge. Two concurrent requests with the same key return `409 IDEMPOTENCY_IN_PROGRESS`. Generate a fresh key per logical operation.
  responses:
    BadRequest:
      description: 'The request was rejected. `code` is either `INVALID_VALIDATION_REQUEST` (Zod schema mismatch; `details` carries a `{ fieldPath: message }` map) or `BAD_REQUEST` (semantic validation failure outside Zod, e.g. mismatched IDs, business-rule violations). Branch on `code`, not status, to tell the two apart.'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            validation:
              summary: Zod schema mismatch
              value:
                error:
                  code: INVALID_VALIDATION_REQUEST
                  message: Invalid request data
                  doc_url: https://docs.formo.so/api/errors#invalid_validation_request
                  details:
                    body.name: String must contain at least 1 character(s)
            semantic:
              summary: Semantic validation failure
              value:
                error:
                  code: BAD_REQUEST
                  message: Target board must be different from the current board
                  doc_url: https://docs.formo.so/api/errors#bad_request
    Conflict:
      description: The request conflicts with current resource state, or an `Idempotency-Key` request with the same key is currently in flight.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error:
              code: IDEMPOTENCY_IN_PROGRESS
              message: A request with this Idempotency-Key is already in progress. Retry shortly.
              doc_url: https://docs.formo.so/api/errors#idempotency_in_progress
  securitySchemes:
    WorkspaceApiKey:
      type: http
      scheme: bearer
      description: Workspace API key (e.g. `formo_xxx`). Create one in the Formo dashboard under Team Settings > API.
    X402Payment:
      type: apiKey
      in: header
      name: X-PAYMENT
      description: x402 payment payload generated after the gateway returns a 402 challenge.
    MPPPayment:
      type: apiKey
      in: header
      name: Authorization
      description: MPP payment authorization header, formatted as `Payment <payload>`, generated after the gateway returns a 402 challenge.
    SdkWriteKey:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'Project SDK write key (a JWT), sent as `Authorization: Bearer <write key>`. This is NOT the `formo_...` workspace API key used on api.formo.so. Find it in the Formo dashboard under the project’s settings.'
x-api-scopes:
  description: API key scopes control access to endpoints. Create keys with the required scopes in Team Settings > API.
  scopes:
    alerts:read: List and get alerts
    alerts:write: Create, update, delete alerts (requires alerts:read)
    boards:read: List and get boards and charts
    boards:write: Create, update, delete boards and charts (requires boards:read)
    contracts:read: List contracts
    contracts:write: Create, update, delete contracts (requires contracts:read)
    segments:read: List segments
    segments:write: Create and delete segments (requires segments:read)
    profiles:read: Search and get wallet profiles
    profiles:write: Update wallet properties, manage labels, and import addresses (requires profiles:read)
    query:read: Execute SQL analytics queries and read pre-built analytics endpoints (KPIs, top pages, lifecycle, retention, revenue, etc.)