EPepilot
Kanban

getKanbanBoards

Changed on

Returns a list of all Kanban boards accessible to the authenticated user.

Use the filter query parameter to narrow results to boards the user owns (owned) or boards shared with them (shared). When omitted, all accessible boards are returned.

get/v1/kanban/boards

Request

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

Query parameters

filter'owned' | 'shared'

Filter boards by ownership type. If not provided, returns all accessible boards.

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 boards

idstring
titlestring
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"
      }
    ]
  }
]

Changes

  • 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