v1

latestOpenAPI 3.0.32026-07-12101432.4 KB

Kanban

getKanbanBoard

Retrieves a Kanban board by ID, including its full configuration (swimlanes, filters, sorting, card fields).

Use "default" as the boardId to retrieve the organization's currently configured default board.

get/v1/kanban/board/{boardId}

Path parameters

boardIdstring required

The board ID, or "default" to get the organization's default board.

Response

Successfully retrieved board

idstring

titlestring required

descriptionstring

created_atstring date-time

updated_atstring date-time

created_bystring

org_idstring

updated_bystring

shared_withstring[]

shared_with_orgboolean

ownersstring[]

Array of user IDs who have full ownership rights for this board (view, edit, delete)

Example response

{
  "title": "Board 1",
  "description": "Board description",
  "config": {
    "dataset": "workflow_tasks_overview",
    "swimlanes": [
      {
        "title": "Swimlane 1",
        "position": 1,
        "filter": {
          "items": [
            {
              "key": "assignee",
              "operator": "EQUALS",
              "value": "100020",
              "data_type": "string"
            }
          ],
          "combination": "OR"
        },
        "title_chip_variant": "success"
      }
    ],
    "card_config": {
      "fields": [
        "assignee"
      ]
    },
    "board_filter": {
      "items": [
        {
          "key": "assignee",
          "operator": "EQUALS",
          "value": "100020",
          "data_type": "string"
        }
      ],
      "combination": "OR"
    },
    "sorting": {
      "field": "created_at"
    },
    "search_query": "task 1"
  }
}