Cogram Board Items API

openapi: 3.2.0
info:
  title: Cogram Board Items API
  description: 'API for integrating with Cogram. Every key is scoped to one organization.


    - **Auth**: `Authorization: Bearer `. Admins mint keys in Organization

    Settings → Integrations → API Keys.

    - **Pagination**: `page` (1-indexed) + `page_size` (default 50, max 100); returns

    `{"data": [...], "total": N, "page": N, "page_size": N}`. `total` = all matches.

    - **Errors**: `{"error": "", "message": ""}`. Branch on `error`; `message`

    wording may change.

    - **Rate limit**: per key, 1000 req/min by default. `429` carries `Retry-After`,

    `X-RateLimit-Limit`, `X-RateLimit-Remaining`.

    - **Attribution**: optional `X-Forwarded-User` header (≤200 chars) names the end user

    behind the call in Cogram''s audit trail.


    See API documentation for guides and examples.'
  version: v1
servers:
- url: /v1
tags:
- name: board-items
  description: Read-only kanban board items, with change history.
paths:
  /board-items:
    get:
      tags:
      - board-items
      summary: List board items
      description: 'List kanban board items in the organization.


        Returns a paginated list across every project in the organization.

        By default, only non-archived items are included.


        Use `project_id` to scope to a single project, `meeting_id` to find

        items originated by a meeting, or `meeting_series_uid` to correlate

        items tied to the same recurring meeting series.


        Use `q` to search `title` and `body` and `assignee` for partial

        name matching (both case-insensitive).


        Sorting by nullable fields (`assignee`, `last_status_changed_at`)

        always places items with no value at the bottom, regardless of sort

        direction.


        Unknown `project_id` or `meeting_id` values return an empty list, not 404.'
      operationId: external_list_board_items_route_board_items_get
      security:
      - HTTPBearer: []
      parameters:
      - name: page
        in: query
        required: false
        schema:
          type: integer
          minimum: 1
          description: Page number (1-indexed).
          default: 1
          title: Page
        description: Page number (1-indexed).
      - name: page_size
        in: query
        required: false
        schema:
          type: integer
          maximum: 100
          minimum: 1
          default: 50
          title: Page Size
      - name: status
        in: query
        required: false
        schema:
          anyOf:
          - title: BoardItemStatus
            enum:
            - TODO
            - IN_PROGRESS
            - DONE
            - DISMISSED
            type: string
          - type: 'null'
          title: Status
      - name: include_archived
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Include Archived
      - name: project_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Project Id
      - name: meeting_id
        in: query
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          description: Filter on `source_meeting_id` — items this meeting created.
          title: Meeting Id
        description: Filter on `source_meeting_id` — items this meeting created.
      - name: meeting_series_uid
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 255
          - type: 'null'
          title: Meeting Series Uid
      - name: assignee
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 255
          - type: 'null'
          description: Case-insensitive partial match on assignee name.
          title: Assignee
        description: Case-insensitive partial match on assignee name.
      - name: q
        in: query
        required: false
        schema:
          anyOf:
          - type: string
            maxLength: 255
          - type: 'null'
          description: Case-insensitive search in `title` and `body`.
          title: Q
        description: Case-insensitive search in `title` and `body`.
      - name: sort_by
        in: query
        required: false
        schema:
          $ref: '#/components/schemas/BoardItemSortBy'
          default: created_at
      - name: sort_dir
        in: query
        required: false
        schema:
          enum:
          - asc
          - desc
          type: string
          default: asc
          title: Sort Dir
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BoardItemListV1'
        '401':
          description: Unauthorized
          content:
            application/json:
              example:
                error: api_key_invalid
                message: Invalid API key
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '422':
          description: Validation error
          content:
            application/json:
              example:
                error: validation_error
                message: 'body -> name: Field required'
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              example:
                error: rate_limit_exceeded
                message: Rate limit exceeded. Please try again later.
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '500':
          description: Internal server error
          content:
            application/json:
              example:
                error: internal_error
                message: An internal error occurred
              schema:
                $ref: '#/components/schemas/ErrorV1'
  /board-items/{item_id}:
    get:
      tags:
      - board-items
      summary: Get board item
      description: 'Get a single board item by id, with its full history timeline.


        `history` is ordered oldest-first. Each entry may represent a status

        transition, an assignee change, a comment, or any combination — see

        the schema reference for details on how to distinguish the cases.


        Returns 404 if the item doesn''t exist or belongs to another organization.'
      operationId: external_get_board_item_route_board_items__item_id__get
      security:
      - HTTPBearer: []
      parameters:
      - name: item_id
        in: path
        required: true
        schema:
          type: string
          title: Item Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BoardItemDetailV1'
        '401':
          description: Unauthorized
          content:
            application/json:
              example:
                error: api_key_invalid
                message: Invalid API key
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '404':
          description: Not found
          content:
            application/json:
              example:
                error: not_found
                message: Resource not found
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '422':
          description: Validation error
          content:
            application/json:
              example:
                error: validation_error
                message: 'body -> name: Field required'
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              example:
                error: rate_limit_exceeded
                message: Rate limit exceeded. Please try again later.
              schema:
                $ref: '#/components/schemas/ErrorV1'
        '500':
          description: Internal server error
          content:
            application/json:
              example:
                error: internal_error
                message: An internal error occurred
              schema:
                $ref: '#/components/schemas/ErrorV1'
components:
  schemas:
    BoardItemSortBy:
      type: string
      enum:
      - created_at
      - updated_at
      - last_status_changed_at
      - status
      - title
      - assignee
      title: BoardItemSortBy
      description: Fields that board items can be sorted by.
    BoardItemV1:
      properties:
        id:
          type: string
          title: Id
        project_id:
          type: string
          title: Project Id
        project_name:
          type: string
          title: Project Name
        title:
          type: string
          title: Title
        body:
          anyOf:
          - type: string
          - type: 'null'
          title: Body
          description: Markdown.
        status:
          type: string
          enum:
          - TODO
          - IN_PROGRESS
          - DONE
          - DISMISSED
          title: BoardItemStatus
        priority:
          anyOf:
          - type: string
            enum:
            - URGENT
            - HIGH
            - NORMAL
            - LOW
            title: BoardItemPriority
          - type: 'null'
          title: Priority
        due_date:
          anyOf:
          - type: string
            format: date
          - type: 'null'
          title: Due Date
          description: Calendar date, no time component.
        assignee:
          anyOf:
          - type: string
          - type: 'null'
          title: Assignee
          description: Free-text name; may differ from the linked user's name.
        assignee_user_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Assignee User Id
          description: Set only when the assignee name matched a Cogram user.
        source_meeting_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Source Meeting Id
        source_meeting_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Source Meeting Name
        meeting_series_uid:
          anyOf:
          - type: string
          - type: 'null'
          title: Meeting Series Uid
        archived:
          type: boolean
          title: Archived
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Updated At
          description: Null if never updated.
        last_status_changed_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Last Status Changed At
          description: Timestamp of the newest history entry.
      type: object
      required:
      - id
      - project_id
      - project_name
      - title
      - body
      - status
      - priority
      - due_date
      - assignee
      - assignee_user_id
      - source_meeting_id
      - source_meeting_name
      - meeting_series_uid
      - archived
      - created_at
      - updated_at
      - last_status_changed_at
      title: BoardItemV1
      description: "A single kanban board item.\n\nDropped relative to the internal ``GlobalBoardItemOutSchema``:\n    * ``organization_id`` — implicit from the API key.\nRenamed:\n    * ``modified_at`` → ``updated_at`` (consistent with ``ActionItemV1``)."
    BoardItemListV1:
      properties:
        data:
          items:
            $ref: '#/components/schemas/BoardItemV1'
          type: array
          title: Data
        total:
          type: integer
          title: Total
          description: Total matches across all pages, not just this page.
        page:
          type: integer
          title: Page
        page_size:
          type: integer
          title: Page Size
      type: object
      required:
      - data
      - total
      - page
      - page_size
      title: BoardItemListV1
      description: Paginated board item list response.
    ErrorCode:
      type: string
      enum:
      - api_key_missing
      - api_key_invalid_format
      - api_key_invalid
      - api_key_expired
      - bad_request
      - forbidden
      - not_found
      - method_not_allowed
      - conflict
      - validation_error
      - rate_limit_exceeded
      - internal_error
      - range_too_large
      - data_export_in_progress
      title: ErrorCode
      description: Error codes for external API v1.
    ErrorV1:
      properties:
        error:
          $ref: '#/components/schemas/ErrorCode'
          description: Stable machine-readable code. Branch on this.
        message:
          type: string
          title: Message
          description: Human-readable detail. Wording may change.
      type: object
      required:
      - error
      - message
      title: ErrorV1
      description: 'JSON body format for all API v1 error responses.


        This model controls the actual serialization of error responses:

        {"error": "not_found", "message": "Project ''xyz'' not found"}'
    BoardItemHistoryEntryV1:
      properties:
        id:
          type: string
          title: Id
        changed_at:
          type: string
          format: date-time
          title: Changed At
        changed_by_user_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Changed By User Id
          description: Null for automated (LLM) changes, and also for a user-made change whose user has since been deleted. Null plus a set `triggered_by_meeting_id` is what identifies an automated change.
        changed_by_user_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Changed By User Name
        triggered_by_meeting_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Triggered By Meeting Id
        triggered_by_meeting_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Triggered By Meeting Name
        previous_status:
          anyOf:
          - type: string
            enum:
            - TODO
            - IN_PROGRESS
            - DONE
            - DISMISSED
            title: BoardItemStatus
          - type: 'null'
          title: Previous Status
          description: Null on the creation entry and on non-status rows.
        new_status:
          anyOf:
          - type: string
            enum:
            - TODO
            - IN_PROGRESS
            - DONE
            - DISMISSED
            title: BoardItemStatus
          - type: 'null'
          title: New Status
          description: Null on non-status rows.
        previous_assignee:
          anyOf:
          - type: string
          - type: 'null'
          title: Previous Assignee
        new_assignee:
          anyOf:
          - type: string
          - type: 'null'
          title: New Assignee
        previous_assignee_user_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Previous Assignee User Id
        new_assignee_user_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: New Assignee User Id
        previous_priority:
          anyOf:
          - type: string
            enum:
            - URGENT
            - HIGH
            - NORMAL
            - LOW
            title: BoardItemPriority
          - type: 'null'
          title: Previous Priority
        new_priority:
          anyOf:
          - type: string
            enum:
            - URGENT
            - HIGH
            - NORMAL
            - LOW
            title: BoardItemPriority
          - type: 'null'
          title: New Priority
        previous_due_date:
          anyOf:
          - type: string
            format: date
          - type: 'null'
          title: Previous Due Date
        new_due_date:
          anyOf:
          - type: string
            format: date
          - type: 'null'
          title: New Due Date
        reason:
          anyOf:
          - type: string
          - type: 'null'
          title: Reason
          description: LLM-authored; only on reconciliation-triggered rows.
        comment:
          anyOf:
          - type: string
          - type: 'null'
          title: Comment
          description: User-authored; null on pure status/assignee rows.
      type: object
      required:
      - id
      - changed_at
      - changed_by_user_id
      - changed_by_user_name
      - triggered_by_meeting_id
      - triggered_by_meeting_name
      - previous_status
      - new_status
      - previous_assignee
      - new_assignee
      - previous_assignee_user_id
      - new_assignee_user_id
      - previous_priority
      - new_priority
      - previous_due_date
      - new_due_date
      - reason
      - comment
      title: BoardItemHistoryEntryV1
      description: "A single history entry on a board item.\n\nEach entry is backed by a ``BoardItemHistoryEntry`` row, which may\nrepresent a status transition, an assignee change, a priority shift,\na due-date move, a comment, or any combination thereof. Consumers\ncan distinguish the case by inspecting:\n\n    * ``previous_status != new_status`` — status transition\n    * ``new_assignee != previous_assignee`` (or ``*_user_id`` equivalents)\n      — assignee change\n    * ``new_priority != previous_priority`` — priority change\n    * ``new_due_date != previous_due_date`` — due-date change\n    * ``comment is not None`` and no other delta — pure comment\n\n``changed_by_user_id == None`` combined with a set ``triggered_by_meeting_id``\nindicates the change was applied automatically by LLM-driven reconciliation."
    BoardItemDetailV1:
      properties:
        id:
          type: string
          title: Id
        project_id:
          type: string
          title: Project Id
        project_name:
          type: string
          title: Project Name
        title:
          type: string
          title: Title
        body:
          anyOf:
          - type: string
          - type: 'null'
          title: Body
          description: Markdown.
        status:
          type: string
          enum:
          - TODO
          - IN_PROGRESS
          - DONE
          - DISMISSED
          title: BoardItemStatus
        priority:
          anyOf:
          - type: string
            enum:
            - URGENT
            - HIGH
            - NORMAL
            - LOW
            title: BoardItemPriority
          - type: 'null'
          title: Priority
        due_date:
          anyOf:
          - type: string
            format: date
          - type: 'null'
          title: Due Date
          description: Calendar date, no time component.
        assignee:
          anyOf:
          - type: string
          - type: 'null'
          title: Assignee
          description: Free-text name; may differ from the linked user's name.
        assignee_user_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Assignee User Id
          description: Set only when the assignee name matched a Cogram user.
        source_meeting_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Source Meeting Id
        source_meeting_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Source Meeting Name
        meeting_series_uid:
          anyOf:
          - type: string
          - type: 'null'
          title: Meeting Series Uid
        archived:
          type: boolean
          title: Archived
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Updated At
          description: Null if never updated.
        last_status_changed_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Last Status Changed At
          description: Timestamp of the newest history entry.
        history:
          items:
            $ref: '#/components/schemas/BoardItemHistoryEntryV1'
          type: array
          title: History
          description: Oldest first.
      type: object
      required:
      - id
      - project_id
      - project_name
      - title
      - body
      - status
      - priority
      - due_date
      - assignee
      - assignee_user_id
      - source_meeting_id
      - source_meeting_name
      - meeting_series_uid
      - archived
      - created_at
      - updated_at
      - last_status_changed_at
      - history
      title: BoardItemDetailV1
      description: 'Single board item with its full history embedded.


        ``history`` is ordered oldest-first, matching the internal history

        endpoint so external consumers see the same timeline ordering.'
  securitySchemes:
    HTTPBearer:
      type: http
      description: Organization API key. Minted by admins in Organization Settings → Integrations → API Keys; shown once, may carry an expiry.
      scheme: bearer
      bearerFormat: Cogram organization API key