mirror of
https://github.com/wekan/wekan.git
synced 2026-11-05 15:45:01 -05:00
Lauri OjansivuandClaude Opus 4.8
b912ddb6f5
The GitHub wiki is disabled and its content was migrated into docs/, so every https://github.com/wekan/wekan/wiki/... link now redirects to the repo home and is broken. Rewrite all internal links in docs/ to relative paths: - wiki/<Page> -> relative path to the corresponding docs/ file (renamed pages mapped explicitly: Caddy-Webserver-Config->Webserver/Caddy.md, Wekan-Markdown ->Features/Markdown/Markdown.md, REST-API-Role->API/Role.md, etc.) - wiki home -> docs/README.md - blob|tree|raw/main|master/<path> -> relative path (anchors and #Lxx line ranges preserved; bare URLs wrapped as [name](path) so they stay clickable) Kept absolute (intentionally not flattened to the current ref): - ref-pinned links (edge, devel, version tags, commit hashes) - links whose target no longer exists in the tree wiki/issues -> the GitHub issues tracker URL (external). 436 links across 113 files; verified no wiki links remain and no broken relative links introduced. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
3.4 KiB
3.4 KiB
Disclaimer
This page tries to be as up to date as possible. If you see something wrong here, feel free to update the page and help other people like you, that greatly depends on our APIs. If you don't feel comfortable doing this kind of changes, please contact us by creating an issue.
Retrieve cards by swimlane id
| API URL / Code Link | Requires Admin Auth | HTTP Method |
|---|---|---|
| /api/boards/:boardId/swimlanes/:swimlaneId/cards | yes |
GET |
curl -H "Authorization: Bearer t7iYB86mXoLfP_XsMegxF41oKT7iiA9lDYiKVtXcctl" \
-X GET \
http://localhost:3000/api/boards/YRgy7Ku6uLFv2pYwZ/swimlanes/PgTuf6sFJsaxto5dC/cards
Result example
{
"_id": "AzEeHS7KAGeYZCcak",
"title": "Create Auth Code",
"description": "Create Auth Code for application.",
"listId": "RPRtDTQMKpShpgqoj"
},
{
...
Add Card to List-Board-Swimlane
| API URL / Code Link | Requires Admin Auth | HTTP Method |
|---|---|---|
| /api/boards/:boardId/lists/:listId/cards | yes |
POST |
curl -H "Authorization: Bearer t7iYB86mXoLfP_XsMegxF41oKT7iiA9lDYiKVtXcctl" \
-H "Content-type:application/json" \
-X POST \
http://localhost:3000/api/boards/YRgy7Ku6uLFv2pYwZ/lists/PgTuf6sFJsaxto5dC/cards \
-d '{ "title": "Card title text", "description": "Card description text", "authorId": "The appropriate existing userId", "swimlaneId": "The destination swimlaneId" }'
Result example
The new card's ID is returned in the format:
{
"_id": "W9m9YxQKT6zZrKzRW"
}
Update a card
You can change (any of) the card's title, list, and description.
| API URL / Code Link | Requires Admin Auth | HTTP Method |
|---|---|---|
| /api/boards/:boardId/lists/:fromListId/cards/:cardId | yes |
PUT |
curl -H "Authorization: Bearer t7iYB86mXoLfP_XsMegxF41oKT7iiA9lDYiKVtXcctl" \
-H "Content-type:application/json" \
-X PUT \
http://localhost:3000/api/boards/YRgy7Ku6uLFv2pYwZ/lists/PgTuf6sFJsaxto5dC/cards/ssrNX9CvXvPxuC5DE \
-d '{ "title": "New title text", "listId": "New destination listId", "description": "New description text" }'
Result example
The card's ID is returned in the format:
{
"_id": "W9m9YxQKT6zZrKzRW"
}
Delete a card
| API URL / Code Link | Requires Admin Auth | HTTP Method |
|---|---|---|
| /api/boards/:boardId/lists/:listId/cards/:cardId | yes |
DELETE |
curl -H "Authorization: Bearer t7iYB86mXoLfP_XsMegxF41oKT7iiA9lDYiKVtXcctl" \
-H "Content-type:application/json" \
-X DELETE \
http://localhost:3000/api/boards/YRgy7Ku6uLFv2pYwZ/lists/PgTuf6sFJsaxto5dC/cards/ssrNX9CvXvPxuC5DE \
-d '{ "authorId": "the appropriate existing userId"}'
Result example
The card's ID is returned in the format:
{
"_id": "W9m9YxQKT6zZrKzRW"
}
In Wekan code
If you believe that code is the best documentation, be our guest: models/cards.js