# WeKan Boards API

**Canonical:** https://apis.io/apis/wekan/wekan-boards-api/  
**Provider:** WeKan — https://apis.io/providers/wekan/  
**Documentation:** https://wekan.github.io/

WeKan Boards API is one of 22 APIs that [WeKan](https://apis.io/providers/wekan/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Boards. The published artifact set on APIs.io includes an OpenAPI specification.

The Boards API from WeKan — 33 operation(s) for boards.

## Operations (44)

| Method | Path | Summary |
|---|---|---|
| GET | `/api/boards/{board}/attachments/{attachment}/export` | This route is used to export a attachement to a json file format |
| GET | `/api/boards/{board}/export` | This route is used to export the board to a json file format |
| GET | `/api/boards/{board}/export/{format}` | Export the board as a NextCloud Deck / OpenProject / GitHub / GitLab / Gitea /… |
| GET | `/api/boards/{board}/export/csv` | This route is used to export the board to a CSV or TSV file format |
| GET | `/api/boards/{board}/export/kanboard` | Export the board as a Kanboard-style JSON (columns + tasks) |
| GET | `/api/boards/{board}/exportExcel` | This route is used to export the board Excel |
| GET | `/api/boards/{board}/exportPDF` | Export a whole board to PDF (board title, lists and their cards) |
| GET | `/api/boards/{board}/exportZip` | Export as a .zip - the JSON document, and the attachments as files |
| GET | `/api/boards/{board}/integrations` | Get board integrations |
| POST | `/api/boards/{board}/integrations` | Post board integrations |
| GET | `/api/boards/{board}/integrations/{int}` | Get board int |
| PUT | `/api/boards/{board}/integrations/{int}` | Put board int |
| DELETE | `/api/boards/{board}/integrations/{int}` | Delete board int |
| DELETE | `/api/boards/{board}/integrations/{int}/activities` | Delete board int activities |
| POST | `/api/boards/{board}/integrations/{int}/activities` | Post board int activities |
| GET | `/api/boards/{board}/lists/{list}/cards/{card}/exportPDF` | This route is used to export the board Excel |
| POST | `/api/import/zip` | Import a .zip export - the document and its attachment files |
| GET | `/api/boards/{boardId}/cardSettings` | Get a board's card settings (display toggles + card aging) |
| PUT | `/api/boards/{boardId}/cardSettings` | Update a board's card settings (display toggles + card aging) |
| GET | `/api/boards` | Get boards |
| POST | `/api/boards` | Post boards |
| GET | `/api/boards/{board}` | Get board |
| DELETE | `/api/boards/{board}` | Delete board |
| GET | `/api/boards/{board}/attachments` | Get board attachments |
| GET | `/api/boards/{board}/boardViewSettings` | Get the Board Settings / Board View of a board |
| PUT | `/api/boards/{board}/boardViewSettings` | Set the Board Settings / Board View of a board |
| GET | `/api/boards/{board}/calendar.ics` | Subscribable iCalendar (.ics) feed of a board's card dates |
| GET | `/api/boards/{board}/cardFieldOrder` | Get the order of the opened card's sections |
| PUT | `/api/boards/{board}/cardFieldOrder` | Set the order of the opened card's sections |
| GET | `/api/boards/{board}/cardSettings` | Get the Board Settings / Card Settings of a board |
| PUT | `/api/boards/{board}/cardSettings` | Set the Board Settings / Card Settings of a board |
| GET | `/api/boards/{board}/charts/{chartKey}/exportExcel` | Export one board report chart to Excel (.xlsx) |
| GET | `/api/boards/{board}/charts/{chartKey}/exportPDF` | Export one board report chart (Dashboard, Burndown, Burnup, CFD, Control Chart… |
| POST | `/api/boards/{board}/copy` | Post board copy |
| GET | `/api/boards/{board}/domains` | Get the email domains a board is shared with |
| POST | `/api/boards/{board}/domains` | Share a board with an email domain |
| DELETE | `/api/boards/{board}/domains/{domain}` | Stop sharing a board with an email domain |
| PUT | `/api/boards/{board}/labels` | Put board labels |
| POST | `/api/boards/{board}/members/{member}` | Post board member |
| PUT | `/api/boards/{board}/title` | Put board title |
| POST | `/api/boards/import` | Import a whole board (with its lists, cards, swimlanes, custom fields and… |
| POST | `/api/boards/import/{source}` | Import a board from another tool's export |
| GET | `/api/boards_count` | Get boards count |
| GET | `/api/users/{user}/boards` | Get user boards |

## Machine-readable artifacts (1)

- **OpenAPI** — https://artifacts.apis.io/wekan/openapi/wekan-boards-api-openapi.yml

## Other WeKan APIs (12)

- [WeKan Attachments API](https://apis.io/apis/wekan/wekan-attachments-api/)
- [WeKan Attachment Storage Settings API](https://apis.io/apis/wekan/wekan-attachmentstoragesettings-api/)
- [WeKan Card Comments API](https://apis.io/apis/wekan/wekan-cardcomments-api/)
- [WeKan Cards API](https://apis.io/apis/wekan/wekan-cards-api/)
- [WeKan Checklists API](https://apis.io/apis/wekan/wekan-checklists-api/)
- [WeKan Dependencies API](https://apis.io/apis/wekan/wekan-dependencies-api/)
- [WeKan Integrations API](https://apis.io/apis/wekan/wekan-integrations-api/)
- [WeKan Lists API](https://apis.io/apis/wekan/wekan-lists-api/)
- [WeKan Login API](https://apis.io/apis/wekan/wekan-login-api/)
- [WeKan Org API](https://apis.io/apis/wekan/wekan-org-api/)
- [WeKan Organizations API](https://apis.io/apis/wekan/wekan-organizations-api/)
- [WeKan Problems API](https://apis.io/apis/wekan/wekan-problems-api/)

## Tags

Boards

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/wekan/wekan-boards-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/wekan/.