EPepilot
Kanban

getKanbanBoard

Changed on

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}

Request

  • Base URL
    https://kanban.sls.epilot.io
  • URL
    https://kanban.sls.epilot.io/v1/kanban/board/{boardId}
  • Auth
    • HTTP bearer
    • or API key in header x-epilot-org-id

Path parameters

boardIdstring required

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

Query parameters

shared_with_format'legacy' | 'grants'

Shape of shared_with in the response. legacy (default) returns plain principal ids; grants returns {user_id, permission} objects and is what clients that understand edit permissions should request.

Response

Successfully retrieved board

idstring
titlestring required
descriptionstring
created_atstring date-time
updated_atstring date-time
created_bystring
org_idstring
updated_bystring
shared_with_orgboolean

Whether the board is shared with the whole organization (equivalent to org_access being set)

org_access'view' | 'edit'

Access level of a share. view is read-only. edit can additionally change the board configuration and title, but cannot delete the board, change sharing or change owners (owners only).

ownersstring[]

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

my_access'owner' | 'edit' | 'view'

Access level of the calling user. Only returned by getKanbanBoard.

Example response

{
  "title": "Board 1",
  "description": "Board description",
  "shared_with": [
    {
      "user_id": "group_abc"
    }
  ],
  "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"
  }
}

Changes

  • 246932aa9fd4Revision changes
    • warning

      added the new flow_template_id enum value to the /// response property for the response status

  • 6857150b8f9bRevision changes
    • breaking

      added subschema #1 to the ///// response property oneOf list for the response status

    • breaking

      the ///// response's property type changed from string to no type for status

    • info

      added the new optional query request parameter shared_with_format

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status