craaft Columns API

openapi: 3.2.0
info:
  title: Craaft Columns API
  version: 1.0.0
  description: 'Personal-access-token API for Craaft. See `docs/api.md` for the

    narrative guide, rate limits, and worked examples.'
  contact:
    name: Craaft
servers:
- url: https://craaft.io/api/v1
  description: Production
- url: http://localhost:8080/api/v1
  description: Local
security:
- bearerAuth: []
tags:
- name: Columns
paths:
  /columns/{id}:
    parameters:
    - name: id
      in: path
      required: true
      schema:
        type: string
        format: uuid
    patch:
      summary: Update a column
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                title:
                  type: string
                  maxLength: 80
                color:
                  type: string
                  nullable: true
                  description: Palette token. null or "" resets to the default colour; omit to leave it unchanged
                position:
                  type: number
                isDone:
                  type: boolean
                cardLimit:
                  type: integer
                  nullable: true
      responses:
        '200':
          description: Updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Column'
      tags:
      - Columns
      operationId: patchColumnsById
      x-operation-id-source: derived
    delete:
      summary: Delete a column (409 if it holds live cards)
      description: 'Only LIVE cards block the delete. Archived cards in the column are

        reassigned to the board''s first column (by position) and the delete

        proceeds - they keep existing and stay archived, so nothing that is

        still searchable is destroyed. Their recorded column changes, which

        is unavoidable once their real column is gone.


        A column that is the board''s only column and holds archived cards

        has nowhere to reassign them to, so it still returns 409.'
      responses:
        '204':
          description: Deleted
        '409':
          description: Column still has live cards
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Columns
      operationId: deleteColumnsById
      x-operation-id-source: derived
  /columns/{id}/archive:
    parameters:
    - name: id
      in: path
      required: true
      schema:
        type: string
        format: uuid
    post:
      summary: Archive all cards in a column
      description: 'Soft-archives every live card in the column - they leave the board

        but stay searchable.


        Only applies to a column flagged `isDone`. On any other column this

        still answers `200` with `{"archived": 0}` rather than an error, so

        check the count instead of relying on the status code.'
      responses:
        '200':
          description: Count and ids of the cards archived
          content:
            application/json:
              schema:
                type: object
                required:
                - archived
                - ids
                properties:
                  archived:
                    type: integer
                  ids:
                    type: array
                    description: Archived card ids, for an undo via POST /cards/{id}/restore
                    items:
                      type: string
                      format: uuid
        '404':
          $ref: '#/components/responses/NotFound'
      tags:
      - Columns
      operationId: postColumnsByIdArchive
      x-operation-id-source: derived
components:
  schemas:
    Error:
      type: object
      required:
      - error
      properties:
        error:
          type: string
    Column:
      type: object
      required:
      - id
      - key
      - title
      - position
      properties:
        id:
          type: string
          format: uuid
        key:
          type: string
          description: Stable identifier for cards.column
        title:
          type: string
          maxLength: 80
        color:
          type: string
          description: Optional palette token; empty for default
        position:
          type: number
        isDone:
          type: boolean
        cardLimit:
          type: integer
          nullable: true
  responses:
    NotFound:
      description: Resource doesn't exist or caller isn't a member of its workspace
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    sessionAuth:
      type: apiKey
      in: cookie
      name: craaft_session
      description: 'Browser session cookie (`__Host-craaft_session` in production,

        `craaft_session` in dev), set at sign-in. Not obtainable through

        this API - it''s here only so the handful of session-only routes

        below (the OAuth consent screen''s own endpoints, connected-apps

        management) can be marked accurately. They reject both bearer

        schemes with a 403.

        '
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: cra_<24 base64url chars>
      description: 'Two token schemes, same permissions. `cra_<24 base64url chars>` is a

        personal access token minted in Settings, doesn''t expire on its own,

        and is revoked from the same page. `cro_<32 base64url chars>` is an

        OAuth access token issued to an OAuth client (an MCP client such as

        Claude) via the authorization-code-with-PKCE flow; it expires after

        1 hour and the client refreshes it. Either token authenticates as

        the user who authorized it, with that user''s exact permissions.


        A token can be read-only: a personal access token created with

        access `read`, or an OAuth grant with scope `craaft:read`. A

        read-only token can send GET, HEAD and OPTIONS; any other method

        gets `403` with "this token is read-only; this request needs a

        token with read and write access", before the request is handled.


        A token can also be limited to chosen boards. Other boards then

        behave as if they don''t exist (`404`, or left out of lists), and

        `POST /projects`, `/imports`, `/members` and `/invitations` answer

        `403` with "this token is limited to some boards; this request

        needs a token for all boards".


        OAuth clients discover every endpoint they need - authorization,

        token, dynamic client registration, revocation - at

        `/.well-known/oauth-authorization-server` (RFC 8414); they don''t

        need to be told the URLs out of band.

        '