Reonic Kanban Boards API

openapi: 3.2.0
info:
  title: Reonic REST Api v3 Kanban Boards API
  description: The Reonic REST API v3 provides programmatic access to create and manage resources.
  version: 3.2.0
  contact:
    email: kontakt@reonic.de
    url: https://reonic.com
    name: Reonic GmbH
servers:
- url: '{apiBaseUrl}/rest/v3/'
security:
- X-Authorization: []
tags:
- name: Kanban Boards
  description: Kanban boards used to group project columns within a lifecycle stage such as request, offer, or installation.
paths:
  /kanbanBoards:
    get:
      summary: List Kanban boards
      description: 'List all Kanban boards for residential and/or commercial projects, with their nested columns.


        **Allowed API keys:** Read-only, Read and Write'
      tags:
      - Kanban Boards
      parameters:
      - schema:
          type: string
          enum:
          - residential
          - commercial
          description: Restrict to boards organizing this project domain (residential or commercial). Returns both domains when omitted.
        required: false
        description: Restrict to boards organizing this project domain (residential or commercial). Returns both domains when omitted.
        name: projectDomain
        in: query
      - schema:
          type: string
          enum:
          - request
          - offer
          - installation
          description: Restrict to boards organizing this lifecycle stage (request, offer, or installation). Returns all stages when omitted.
        required: false
        description: Restrict to boards organizing this lifecycle stage (request, offer, or installation). Returns all stages when omitted.
        name: projectStage
        in: query
      - schema:
          type: string
          enum:
          - exclude
          - include
          - only
          default: exclude
          description: 'Controls whether archived boards appear in results. Default: exclude.'
        required: false
        description: 'Controls whether archived boards appear in results. Default: exclude.'
        name: archived
        in: query
      - schema:
          type: string
          example: no-cache
        required: false
        name: Reonic-Cache-Control
        in: header
        description: Set to 'no-cache' to bypass the 1-hour response cache and force a fresh read. The fresh response is then written back to the cache for subsequent callers. Forced refreshes count against the uncached rate-limit bucket (30/min); only cache hits count against the cached bucket (500/min).
      responses:
        '200':
          description: List of all Kanban boards
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/KanbanBoard'
                    description: List of items
                required:
                - data
      operationId: getKanbanBoards
      x-operation-id-source: derived
  /kanbanBoards/{boardId}:
    get:
      summary: Get Kanban board
      description: 'Get a single Kanban board by its ID, including its nested columns.


        **Allowed API keys:** Read-only, Read and Write'
      tags:
      - Kanban Boards
      parameters:
      - schema:
          type: string
          format: uuid
        required: true
        name: boardId
        in: path
      - schema:
          type: string
          example: no-cache
        required: false
        name: Reonic-Cache-Control
        in: header
        description: Set to 'no-cache' to bypass the 1-hour response cache and force a fresh read. The fresh response is then written back to the cache for subsequent callers. Forced refreshes count against the uncached rate-limit bucket (30/min); only cache hits count against the cached bucket (500/min).
      responses:
        '200':
          description: The Kanban board
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KanbanBoard'
      operationId: getKanbanBoardsByBoardId
      x-operation-id-source: derived
components:
  schemas:
    KanbanBoard:
      type: object
      properties:
        id:
          type: string
          format: uuid
          example: 123e4567-e89b-12d3-a456-426614174000
        name:
          type: string
        description:
          type:
          - string
          - 'null'
        projectDomain:
          type: string
          enum:
          - residential
          - commercial
          description: Project domain this board organizes. Each board is scoped to either residential or commercial projects, never both.
        projectStage:
          type: string
          enum:
          - request
          - offer
          - installation
          description: Lifecycle stage of the projects this board organizes. Each board is scoped to a single stage.
        columns:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: uuid
                example: 123e4567-e89b-12d3-a456-426614174000
              name:
                type: string
              position:
                type: integer
                minimum: 0
                description: Order within the board, ascending from left to right.
              archivedAt:
                type:
                - string
                - 'null'
                format: date-time
                example: '2026-01-01T15:30:00.000Z'
            required:
            - id
            - name
            - position
            - archivedAt
          description: Columns belonging to this board. See [**Kanban Columns**](#tag/kanban-columns)
        archivedAt:
          type:
          - string
          - 'null'
          format: date-time
          example: '2026-01-01T15:30:00.000Z'
          description: When the board was archived, or null if still active.
      required:
      - id
      - name
      - description
      - projectDomain
      - projectStage
      - columns
      - archivedAt
  securitySchemes:
    X-Authorization:
      type: apiKey
      in: header
      name: X-Authorization
x-tagGroups:
- name: People
  tags:
  - Contacts
  - Users
  - Teams
- name: Projects
  tags:
  - Residential Projects
  - Commercial Projects
- name: Working on a project
  tags:
  - Notes
  - Tasks
  - Files
  - File Folders
  - Activities
  - Time Tracking
  - Checklists
  - Checklist Templates
  - Signature Requests
- name: Calendar
  tags:
  - Calendars
  - Calendar Categories
  - Appointments
- name: Catalog
  tags:
  - Components
  - Planning Templates
  - Planning Packages
  - Offer Templates
- name: Workspace setup
  tags:
  - Kanban Boards
  - Kanban Columns
  - Tags
  - Lead Sources
- name: Wiki
  tags:
  - Wiki
- name: Services
  tags:
  - Photogrammetry
- name: API helpers
  tags:
  - Upload
  - Links
- name: Integrations
  tags:
  - Webhooks
- name: Guides
  tags:
  - Migrating from API v2 to v3
  - Changelog