Skip to main content
Glama

@shichao402/vikunja-mcp

English | 简体中文

A Vikunja MCP server you can start directly with npx, using stdio transport for Claude Desktop, Cursor, Cherry Studio, and any other MCP-compatible client.

The current package exposes two layers:

  • 19 ergonomic tools for day-to-day project, task, label, and comment workflows

  • 161 raw REST tools generated from the bundled Vikunja Swagger snapshot, covering every documented operation in that snapshot

That means the package currently exposes 180 MCP tools in total. Raw tools use compact names shaped as vk_<method>_<resource>_<hash12>; each tool description still includes the exact REST operation so the model can call any Vikunja API endpoint precisely when needed.

Installation

No global install is required. The recommended distribution path is npx:

npx -y @shichao402/vikunja-mcp

Related MCP server: Vikunja MCP Server

Environment Variables

You must at least provide the Vikunja base URL:

VIKUNJA_BASE_URL=https://vikunja.example.com

API token authentication is the preferred option:

VIKUNJA_API_TOKEN=your_token

Supported environment variables:

VIKUNJA_BASE_URL=https://vikunja.example.com
VIKUNJA_API_TOKEN=your_api_token

# Optional alias
VIKUNJA_URL=https://vikunja.example.com

# Optional username/password login for self-hosted Vikunja
VIKUNJA_USERNAME=your_username
VIKUNJA_PASSWORD=your_password
VIKUNJA_TOTP_PASSCODE=123456
VIKUNJA_LONG_TOKEN=true

Notes:

  • VIKUNJA_API_TOKEN works for both Vikunja Cloud and self-hosted instances and has the highest priority.

  • VIKUNJA_USERNAME and VIKUNJA_PASSWORD are intended for self-hosted instances. The server will call /api/v1/login, cache the JWT, and reuse it.

  • If you pass a URL ending in /api/v1, the server normalizes it automatically.

Claude Desktop Example

{
  "mcpServers": {
    "vikunja": {
      "command": "npx",
      "args": ["-y", "@shichao402/vikunja-mcp"],
      "env": {
        "VIKUNJA_BASE_URL": "https://vikunja.example.com",
        "VIKUNJA_API_TOKEN": "your_api_token"
      }
    }
  }
}

Tool Layers

Ergonomic tools:

  • vikunja_get_server_info

  • vikunja_get_current_user

  • vikunja_list_projects

  • vikunja_get_project

  • vikunja_create_project

  • vikunja_update_project

  • vikunja_delete_project

  • vikunja_list_tasks

  • vikunja_get_task

  • vikunja_create_task

  • vikunja_update_task

  • vikunja_delete_task

  • vikunja_list_labels

  • vikunja_create_label

  • vikunja_list_task_labels

  • vikunja_add_label_to_task

  • vikunja_remove_label_from_task

  • vikunja_list_task_comments

  • vikunja_create_task_comment

Raw tools:

  • One raw tool for each of the 161 operations in the bundled Vikunja Swagger snapshot

  • Compact generated names, for example vk_put_filters_dac0a4e19aa2, vk_post_tasks_2ca74cd58ce3, vk_put_projects_18c03cfa3b5a, vk_put_tasks_25d391326d4f

  • Path and query parameters are top-level fields

  • JSON request payloads go in body

  • Multipart uploads go in form

  • File values inside form use { "filename": "a.txt", "contentBase64": "...", "contentType": "text/plain" }

  • Binary download endpoints return { kind, contentType, filename, contentBase64, size }

API Coverage

Full coverage details and remaining limitations are tracked in English coverage docs and 中文覆盖文档.

Current status:

  • Swagger operations in the bundled snapshot: 161

  • Raw MCP coverage: 161 / 161

  • Additional ergonomic tools: 19

  • POST /login is exposed both as a raw tool and as an internal self-hosted login capability

Testing

Contract tests:

npm test

Live smoke tests against a real Vikunja instance:

VIKUNJA_LIVE_BASE_URL=http://127.0.0.1:34560 \
VIKUNJA_LIVE_USERNAME=mcpadmin \
VIKUNJA_LIVE_PASSWORD='StrongPass123!' \
npm run test:live

Local Development

npm install
npm run build

Show help:

node dist/index.js --help

Publishing

The package is intentionally distributed via npx because that is the lowest-friction path for MCP clients.

Publishing is automated through GitHub Actions, not local npm publish:

  1. Update package.json, package-lock.json, and CHANGELOG.md for the new version.

  2. Commit the release metadata, for example chore: release v0.5.0.

  3. Create and push a matching v* tag, for example v0.5.0.

  4. The Publish to npm workflow publishes to npm via trusted publishing/OIDC.

The workflow verifies that the pushed tag version matches package.json before publishing.

GitHub repository: https://github.com/shichao402/vikunja-mcp

Available Tools

180 tools
vikunja_add_label_to_taskB

Attach an existing label to a task.

Inputs: task_id (required), label_id (required).

vikunja_create_labelB

Create a new label.

Inputs: title (required), hex_color, description.

vikunja_create_projectC

Create a new Vikunja project.

Inputs: title (required), position, hex_color, identifier, +4 more.

vikunja_create_taskB

Create a task inside a project.

Inputs: title (required), project_id (required), done, due_date, +10 more.

vikunja_create_task_commentC

Create a comment on a task.

Inputs: comment (required), task_id (required).

vikunja_delete_projectB

Delete a project by ID.

Inputs: project_id (required).

vikunja_delete_taskB

Delete a task by ID.

Inputs: task_id (required).

vikunja_get_current_userA

Get the authenticated Vikunja user profile and settings for the configured credentials.

Inputs: no named parameters.

vikunja_get_projectA

Get a single project by ID.

Inputs: project_id (required).

vikunja_get_server_infoA

Get public information about the configured Vikunja instance, including version and enabled settings. No auth token is required.

Inputs: no named parameters.

vikunja_get_taskB

Get a single task by ID.

Inputs: task_id (required), expand.

vikunja_list_labelsA

List labels visible to the authenticated user.

Inputs: page, search, per_page.

vikunja_list_projectsA

List projects visible to the authenticated Vikunja user.

Inputs: page, search, per_page, is_archived, +1 more.

vikunja_list_task_commentsA

List comments on a task.

Inputs: task_id (required), order_by.

vikunja_list_task_labelsA

List labels attached to a task.

Inputs: task_id (required), page, search, per_page.

vikunja_list_tasksA

List tasks across all accessible projects, with optional search, filtering, sorting, and expansions.

Inputs: page, expand, filter, search, +5 more.

vikunja_remove_label_from_taskB

Remove a label from a task.

Inputs: task_id (required), label_id (required).

vikunja_update_projectC

Update an existing Vikunja project.

Inputs: project_id (required), title, position, hex_color, +5 more.

vikunja_update_taskA

Update an existing task with PATCH-style semantics. By default only the fields you pass are changed; every other field keeps its current value (the MCP server reads the task first and merges your input on top). Set _replace: true to opt out and use Vikunja's native full-replacement behavior, which resets every unspecified field to its type default.

Inputs: task_id (required), done, title, _replace, +12 more.

vk_delete_filters_8a7213bcbb31A

Removes a saved filter. Raw Vikunja REST proxy for DELETE /filters/{id}. Removes a saved filter by its ID. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: id.

vk_delete_labels_5f843a6b3e85A

Delete a label. Raw Vikunja REST proxy for DELETE /labels/{id}. Delete an existing label. The user needs to be the creator of the label to be able to do this. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: id.

vk_delete_projects_0a6061600a7cA

Deletes an existing bucket. Raw Vikunja REST proxy for DELETE /projects/{projectID}/views/{view}/buckets/{bucketID}. Deletes an existing kanban bucket and dissociates all of its task. It does not delete any tasks. You cannot delete the last bucket on a project. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: view, bucketID, bucketId, bucket_id, +3 more.

vk_delete_projects_16ac08a9841cA

Remove a project background. Raw Vikunja REST proxy for DELETE /projects/{id}/background. Removes a previously set project background, regardless of the project provider used to set the background. It does not throw an error if the project does not have a background. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: id.

vk_delete_projects_3798ab1e7dc9A

Delete a team from a project. Raw Vikunja REST proxy for DELETE /projects/{projectID}/teams/{teamID}. Delets a team from a project. The team won't have access to the project anymore. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: teamID, teamId, team_id, projectID, +2 more.

vk_delete_projects_49c21c5d6153A

Delete a project view. Raw Vikunja REST proxy for DELETE /projects/{project}/views/{id}. Deletes a project view. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: id, project.

vk_delete_projects_79232e6c95f0A

Delete a user from a project. Raw Vikunja REST proxy for DELETE /projects/{projectID}/users/{userID}. Delets a user from a project. The user won't have access to the project anymore. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: userID, userId, user_id, projectID, +2 more.

vk_delete_projects_aaf8e9ef7dfeB

Deletes a project. Raw Vikunja REST proxy for DELETE /projects/{id}. Delets a project This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: id.

vk_delete_projects_c34503b3af9aA

Remove a link share. Raw Vikunja REST proxy for DELETE /projects/{project}/shares/{share}. Remove a link share. The user needs to have write-access to the project to be able do this. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: share, project.

vk_delete_projects_f3929b4920d0A

Deletes an existing webhook target. Raw Vikunja REST proxy for DELETE /projects/{id}/webhooks/{webhookID}. Delete any of the project's webhook targets. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: id, webhookID, webhookId, webhook_id.

vk_delete_subscrip_57c818aa195aA

Unsubscribe the current user from an entity.. Raw Vikunja REST proxy for DELETE /subscriptions/{entity}/{entityID}. Unsubscribes the current user to an entity. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: entity, entityID, entityId, entity_id.

vk_delete_tasks_37e94f6423f8A

Remove a task comment. Raw Vikunja REST proxy for DELETE /tasks/{taskID}/comments/{commentID}. Remove a task comment. The user doing this need to have at least write access to the task this comment belongs to. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: taskID, taskId, task_id, commentID, +2 more.

vk_delete_tasks_65a02db73f28A

Remove a label from a task. Raw Vikunja REST proxy for DELETE /tasks/{task}/labels/{label}. Remove a label from a task. The user needs to have write-access to the project to be able do this. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: task, label.

vk_delete_tasks_88ea47d49817A

Delete a task. Raw Vikunja REST proxy for DELETE /tasks/{id}. Deletes a task from a project. This does not mean "mark it done". This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: id.

vk_delete_tasks_9353a9555fc4A

Delete an assignee. Raw Vikunja REST proxy for DELETE /tasks/{taskID}/assignees/{userID}. Un-assign a user from a task. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: taskID, taskId, userID, userId, +2 more.

vk_delete_tasks_95df65ce0d48A

Delete an attachment. Raw Vikunja REST proxy for DELETE /tasks/{id}/attachments/{attachmentID}. Delete an attachment. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: id, attachmentID, attachmentId, attachment_id.

vk_delete_tasks_a75cf5df971fB

Remove a task relation. Raw Vikunja REST proxy for DELETE /tasks/{taskID}/relations/{relationKind}/{otherTaskID}. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body (required), taskID, taskId, task_id, +5 more.

vk_delete_teams_0bdccd633612A

Deletes a team. Raw Vikunja REST proxy for DELETE /teams/{id}. Delets a team. This will also remove the access for all users in that team. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: id.

vk_delete_teams_e7d740105b63A

Remove a user from a team. Raw Vikunja REST proxy for DELETE /teams/{id}/members/{username}. Remove a user from a team. This will also revoke any access this user might have via that team. A user can remove themselves from the team if they are not the last user in the team. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: id, username.

vk_delete_test_bfe51f44bd2aA

Truncate all tables. Raw Vikunja REST proxy for DELETE /test/all. Removes all data from every Vikunja table. Used by e2e tests to ensure clean state before each test. Requires the testing token. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: no named parameters.

vk_delete_tokens_dcb58e5a4fddA

Deletes an existing api token. Raw Vikunja REST proxy for DELETE /tokens/{tokenID}. Delete any of the user's api tokens. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: tokenID, tokenId, token_id.

vk_delete_user_9716beec9c6eA

Delete a caldav token by id. Raw Vikunja REST proxy for DELETE /user/settings/token/caldav/{id}. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: id.

vk_delete_user_e70dd65f1614A

Delete a user-level webhook target. Raw Vikunja REST proxy for DELETE /user/settings/webhooks/{id}. Delete a user-level webhook target. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: id.

vk_get_backgrou_9a4b6fd79afdA

Get an unsplash image. Raw Vikunja REST proxy for GET /backgrounds/unsplash/image/{image}. Get an unsplash image. Returns json on error. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: image.

vk_get_backgrou_a6990b2bc73aA

Get an unsplash thumbnail image. Raw Vikunja REST proxy for GET /backgrounds/unsplash/image/{image}/thumb. Get an unsplash thumbnail image. The thumbnail is cropped to a max width of 200px. Returns json on error. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: image.

vk_get_backgrou_abf04358d617B

Search for a background from unsplash. Raw Vikunja REST proxy for GET /backgrounds/unsplash/search. Search for a project background from unsplash This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: p, s.

vk_get_filters_abb5ba3ccbd2A

Gets one saved filter. Raw Vikunja REST proxy for GET /filters/{id}. Returns a saved filter by its ID. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: id.

vk_get_info_738181b06d10A

Info. Raw Vikunja REST proxy for GET /info. Returns the version, frontendurl, motd and various settings of Vikunja This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is not required.

Inputs: no named parameters.

vk_get_kind_0ad7494fdd0dA

Get all reactions for an entity. Raw Vikunja REST proxy for GET /{kind}/{id}/reactions. Returns all reactions for an entity This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: id, kind.

vk_get_labels_755169797d86A

Get all labels a user has access to. Raw Vikunja REST proxy for GET /labels. Returns all labels which are either created by the user or associated with a task the user has at least read-access to. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: s, page, perPage, per_page.

vk_get_labels_f4188d175a30A

Gets one label. Raw Vikunja REST proxy for GET /labels/{id}. Returns one label by its ID. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: id.

vk_get_migratio_0cad66c45d22A

Get migration status. Raw Vikunja REST proxy for GET /migration/vikunja-file/status. Returns if the current user already did the migation or not. This is useful to show a confirmation message in the frontend if the user is trying to do the same migration again. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: no named parameters.

vk_get_migratio_1f7674d0435fA

Get migration status. Raw Vikunja REST proxy for GET /migration/ticktick/status. Returns if the current user already did the migation or not. This is useful to show a confirmation message in the frontend if the user is trying to do the same migration again. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: no named parameters.

vk_get_migratio_21b0bedf6792A

Get migration status. Raw Vikunja REST proxy for GET /migration/microsoft-todo/status. Returns if the current user already did the migation or not. This is useful to show a confirmation message in the frontend if the user is trying to do the same migration again. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: no named parameters.

vk_get_migratio_2e1cd33c4fe5A

Get migration status. Raw Vikunja REST proxy for GET /migration/trello/status. Returns if the current user already did the migation or not. This is useful to show a confirmation message in the frontend if the user is trying to do the same migration again. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: no named parameters.

vk_get_migratio_50005efadfa2A

Get migration status. Raw Vikunja REST proxy for GET /migration/todoist/status. Returns if the current user already did the migation or not. This is useful to show a confirmation message in the frontend if the user is trying to do the same migration again. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: no named parameters.

vk_get_migratio_6ce6501364d7A

Get migration status. Raw Vikunja REST proxy for GET /migration/wekan/status. Returns if the current user already did the migration or not. This is useful to show a confirmation message in the frontend if the user is trying to do the same migration again. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: no named parameters.

vk_get_migratio_c4ad1b528a60A

Get the auth url from todoist. Raw Vikunja REST proxy for GET /migration/todoist/auth. Returns the auth url where the user needs to get its auth code. This code can then be used to migrate everything from todoist to Vikunja. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: no named parameters.

vk_get_migratio_df7ac82f740dA

Get the auth url from Microsoft Todo. Raw Vikunja REST proxy for GET /migration/microsoft-todo/auth. Returns the auth url where the user needs to get its auth code. This code can then be used to migrate everything from Microsoft Todo to Vikunja. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: no named parameters.

vk_get_migratio_f20a137a3abdA

Get the auth url from trello. Raw Vikunja REST proxy for GET /migration/trello/auth. Returns the auth url where the user needs to get its auth code. This code can then be used to migrate everything from trello to Vikunja. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: no named parameters.

vk_get_migratio_f7952041f174A

Get CSV migration status. Raw Vikunja REST proxy for GET /migration/csv/status. Returns if the current user already did the CSV migration or not. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: no named parameters.

vk_get_notifica_4bf31ea26a70A

Get all notifications for the current user. Raw Vikunja REST proxy for GET /notifications. Returns an array with all notifications for the current user. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: page, perPage, per_page.

vk_get_projects_25ac8903752bA

Gets one project. Raw Vikunja REST proxy for GET /projects/{id}. Returns a project by its ID. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: id.

vk_get_projects_400b725fb618A

Get the project background. Raw Vikunja REST proxy for GET /projects/{id}/background. Get the project background of a specific project. Returns json on error. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: id.

vk_get_projects_59697f95509cA

Get users on a project. Raw Vikunja REST proxy for GET /projects/{id}/users. Returns a project with all users which have access on a given project. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: s, id, page, perPage, +1 more.

vk_get_projects_59d26cf6f54dA

Get tasks in a project. Raw Vikunja REST proxy for GET /projects/{id}/views/{view}/tasks. Returns all tasks for the selected project. When the requested view is a kanban view, a list of buckets containing the tasks will be returned. Otherwise, a list of tasks will be returned. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: s, id, page, view, +12 more.

vk_get_projects_5ec34f7d9c12A

Get one task by its per-project index. Raw Vikunja REST proxy for GET /projects/{project}/tasks/by-index/{index}. Returns a single task identified by its per-project index. Useful when resolving human-readable references like "PROJ-42" to a canonical task object. Note that task indexes are reassigned when a task is moved between projects, so long-lived references should use the returned task id instead. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: index, expand, project.

vk_get_projects_76eb7fb509abA

Get one link shares for a project. Raw Vikunja REST proxy for GET /projects/{project}/shares/{share}. Returns one link share by its ID. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: share, project.

vk_get_projects_7a3678e824dfA

Get all kanban buckets of a project. Raw Vikunja REST proxy for GET /projects/{id}/views/{view}/buckets. Returns all kanban buckets which belong to that project. Buckets are always sorted by their position in ascending order. To get all buckets with their tasks, use the tasks endpoint with a kanban view. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: id, view.

vk_get_projects_9602e3579c88A

Get all link shares for a project. Raw Vikunja REST proxy for GET /projects/{project}/shares. Returns all link shares which exist for a given project This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: s, page, perPage, project, +1 more.

vk_get_projects_a15669b58cc2A

Get users. Raw Vikunja REST proxy for GET /projects/{id}/projectusers. Lists all users (without emailadresses). Also possible to search for a specific user. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: s, id.

vk_get_projects_a99a3200bd60A

Get teams on a project. Raw Vikunja REST proxy for GET /projects/{id}/teams. Returns a project with all teams which have access on a given project. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: s, id, page, perPage, +1 more.

vk_get_projects_bea128e9f35aA

Get all api webhook targets for the specified project. Raw Vikunja REST proxy for GET /projects/{id}/webhooks. Get all api webhook targets for the specified project. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: id, page, perPage, per_page.

vk_get_projects_d22c15625caeA

Get all project views for a project. Raw Vikunja REST proxy for GET /projects/{project}/views. Returns all project views for a sepcific project This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: project.

vk_get_projects_ea259a6d929fA

Get one project view. Raw Vikunja REST proxy for GET /projects/{project}/views/{id}. Returns a project view by its ID. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: id, project.

vk_get_projects_f38653f9871eA

Get all projects a user has access to. Raw Vikunja REST proxy for GET /projects. Returns all projects a user has access to. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: s, page, expand, perPage, +3 more.

vk_get_routes_bd34e224b009A

Get a list of all token api routes. Raw Vikunja REST proxy for GET /routes. Returns a list of all API routes which are available to use with an api token, not a user login. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: no named parameters.

vk_get_tasks_07bdccc5bc22A

Get a task comment. Raw Vikunja REST proxy for GET /tasks/{taskID}/comments/{commentID}. Get a task comment. The user doing this need to have at least read access to the task this comment belongs to. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: taskID, taskId, task_id, commentID, +2 more.

vk_get_tasks_2f9eac1bb74dA

Get all attachments for one task.. Raw Vikunja REST proxy for GET /tasks/{id}/attachments. Get all task attachments for one task. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: id, page, perPage, per_page.

vk_get_tasks_4ef472b350b5A

Get tasks. Raw Vikunja REST proxy for GET /tasks. Returns all tasks on any project the user has access to. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: s, page, expand, filter, +10 more.

vk_get_tasks_559e34c16db8A

Get all assignees for a task. Raw Vikunja REST proxy for GET /tasks/{taskID}/assignees. Returns an array with all assignees for this task. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: s, page, taskID, taskId, +3 more.

vk_get_tasks_59454936c1f5A

Get one task. Raw Vikunja REST proxy for GET /tasks/{id}. Returns one task by its ID This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: id, expand.

vk_get_tasks_f038453ed58cA

Get one attachment.. Raw Vikunja REST proxy for GET /tasks/{id}/attachments/{attachmentID}. Get one attachment for download. Returns json on error. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: id, previewSize, attachmentID, attachmentId, +2 more.

vk_get_tasks_f2f5b2cb6ee4B

Get all task comments. Raw Vikunja REST proxy for GET /tasks/{taskID}/comments. Get all task comments. The user doing this need to have at least read access to the task. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: taskID, taskId, orderBy, task_id, +1 more.

vk_get_tasks_f7c70820b984B

Get all labels on a task. Raw Vikunja REST proxy for GET /tasks/{task}/labels. Returns all labels which are assicociated with a given task. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: s, page, task, perPage, +1 more.

vk_get_teams_e326281be9a8A

Gets one team. Raw Vikunja REST proxy for GET /teams/{id}. Returns a team by its ID. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: id.

vk_get_teams_e360f482b9bdA

Get teams. Raw Vikunja REST proxy for GET /teams. Returns all teams the current user is part of. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: s, page, perPage, per_page.

vk_get_tokens_d975a9c58335A

Get all api tokens of the current user. Raw Vikunja REST proxy for GET /tokens. Returns all api tokens the current user has created. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: s, page, perPage, per_page.

vk_get_user_09683fc66a78A

Totp QR Code. Raw Vikunja REST proxy for GET /user/settings/totp/qrcode. Returns a qr code for easier setup at end user's devices. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: no named parameters.

vk_get_user_5184b90863d9A

Get user information. Raw Vikunja REST proxy for GET /user. Returns the current user object with their settings. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: no named parameters.

vk_get_user_63af5972a27dA

Returns the caldav tokens for the current user. Raw Vikunja REST proxy for GET /user/settings/token/caldav. Return the IDs and created dates of all caldav tokens for the current user. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: no named parameters.

vk_get_user_9d50b2668fcfA

Get current user data export. Raw Vikunja REST proxy for GET /user/export. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: no named parameters.

vk_get_user_afff25db6cb4A

Return user avatar setting. Raw Vikunja REST proxy for GET /user/settings/avatar. Returns the current user's avatar setting. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: no named parameters.

vk_get_user_b690f67e3bd8A

Totp setting for the current user. Raw Vikunja REST proxy for GET /user/settings/totp. Returns the current user totp setting or an error if it is not enabled. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: no named parameters.

vk_get_user_e91f706eeea8A

Get all available time zones on this vikunja instance. Raw Vikunja REST proxy for GET /user/timezones. Because available time zones depend on the system Vikunja is running on, this endpoint returns a project of all valid time zones this particular Vikunja instance can handle. The project of time zones is not sorted, you should sort it on the client. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: no named parameters.

vk_get_user_ebd4cdbf4043A

Get available user-directed webhook events. Raw Vikunja REST proxy for GET /user/settings/webhooks/events. Get all webhook events that can be used with user-level webhook targets. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: no named parameters.

vk_get_user_ee38a5cfdcfcA

Get all user-level webhook targets. Raw Vikunja REST proxy for GET /user/settings/webhooks. Get all webhook targets configured for the current user (not project-specific). This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: no named parameters.

vk_get_username_99fb060909c5A

User Avatar. Raw Vikunja REST proxy for GET /{username}/avatar. Returns the user avatar as image. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is not required.

Inputs: size, username.

vk_get_users_ca0e1629bee9A

Get users. Raw Vikunja REST proxy for GET /users. Search for a user by its username, name or full email. Name (not username) or email require that the user has enabled this in their settings, unless both users share an external team (synced via OIDC/LDAP), in which case they can always find each other. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: s.

vk_get_webhooks_7a215dc6e786A

Get all possible webhook events. Raw Vikunja REST proxy for GET /webhooks/events. Get all possible webhook events to use when creating or updating a webhook target. This endpoint does not usually require a request body. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: no named parameters.

vk_patch_test_48973863d43cA

Reset the db to a defined state. Raw Vikunja REST proxy for PATCH /test/{table}. Fills the specified table with the content provided in the payload. You need to enable the testing endpoint before doing this and provide the Authorization: <token> secret when making requests to this endpoint. See docs for more details. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body, table.

vk_post_auth_2af0c2402604A

Authenticate a user with OpenID Connect. Raw Vikunja REST proxy for POST /auth/openid/{provider}/callback. After a redirect from the OpenID Connect provider to the frontend has been made with the authentication code, this endpoint can be used to obtain a jwt token for that user and thus log them in. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is not required.

Inputs: body (required), provider.

vk_post_filters_52aa420f91fdB

Updates a saved filter. Raw Vikunja REST proxy for POST /filters/{id}. Updates a saved filter by its ID. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: id, body.

vk_post_kind_8f46997cec95B

Removes the user's reaction. Raw Vikunja REST proxy for POST /{kind}/{id}/reactions/delete. Removes the reaction of that user on that entity. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body (required), id, kind.

vk_post_login_02b20554af73B

Login. Raw Vikunja REST proxy for POST /login. Logs a user in. Returns a JWT-Token to authenticate further requests. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is not required.

Inputs: body (required).

vk_post_migratio_3b7cc1a332d4C

Migrate all projects, tasks etc. from Microsoft Todo. Raw Vikunja REST proxy for POST /migration/microsoft-todo/migrate. Migrates all tasklinsts, tasks, notes and reminders from Microsoft Todo to Vikunja. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body (required).

vk_post_migratio_417aa4490490A

Import all projects, tasks etc. from a Vikunja data export. Raw Vikunja REST proxy for POST /migration/vikunja-file/migrate. Imports all projects, tasks, notes, reminders, subtasks and files from a Vikunjda data export into Vikunja. Pass multipart form data in the form field. File values use an object with filename, contentBase64 and optional contentType. Multi-file fields accept arrays. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Form fields: import. Required: import. Authentication is required.

Inputs: form (required).

vk_post_migratio_4be575987d38C

Migrate all projects, tasks etc. from trello. Raw Vikunja REST proxy for POST /migration/trello/migrate. Migrates all projects, tasks, notes, reminders, subtasks and files from trello to vikunja. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body (required).

vk_post_migratio_a1f23411fbe1B

Migrate all lists, tasks etc. from todoist. Raw Vikunja REST proxy for POST /migration/todoist/migrate. Migrates all projects, tasks, notes, reminders, subtasks and files from todoist to vikunja. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body (required).

vk_post_notifica_7cae6bbc334bA

Mark all notifications of a user as read. Raw Vikunja REST proxy for POST /notifications. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body.

vk_post_notifica_c728b00fdf22A

Mark a notification as (un-)read. Raw Vikunja REST proxy for POST /notifications/{id}. Marks a notification as either read or unread. A user can only mark their own notifications as read. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: id, body.

vk_post_projects_1786d4524662A

Updates a project view. Raw Vikunja REST proxy for POST /projects/{project}/views/{id}. Updates a project view. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body (required), id, project.

vk_post_projects_3ca115fec881B

Set an unsplash photo as project background. Raw Vikunja REST proxy for POST /projects/{id}/backgrounds/unsplash. Sets a photo from unsplash as project background. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body (required), id.

vk_post_projects_4bd6e2576c36B

Update an existing bucket. Raw Vikunja REST proxy for POST /projects/{projectID}/views/{view}/buckets/{bucketID}. Updates an existing kanban bucket. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body (required), view, bucketID, bucketId, +4 more.

vk_post_projects_89e8a729a046A

Update a user <-> project relation. Raw Vikunja REST proxy for POST /projects/{projectID}/users/{userID}. Update a user <-> project relation. Mostly used to update the permission that user has. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body (required), userID, userId, user_id, +3 more.

vk_post_projects_8d2cec004db2A

Update a team <-> project relation. Raw Vikunja REST proxy for POST /projects/{projectID}/teams/{teamID}. Update a team <-> project relation. Mostly used to update the permission that team has. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body (required), teamID, teamId, team_id, +3 more.

vk_post_projects_9978989ab223C

Updates a project. Raw Vikunja REST proxy for POST /projects/{id}. Updates a project. This does not include adding a task (see below). Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body (required), id.

vk_post_projects_bc69e950924aC

Update a task bucket. Raw Vikunja REST proxy for POST /projects/{project}/views/{view}/buckets/{bucket}/tasks. Updates a task in a bucket Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body (required), view, bucket, project.

vk_post_projects_ea031ad60f34A

Change a webhook target's events.. Raw Vikunja REST proxy for POST /projects/{id}/webhooks/{webhookID}. Change a webhook target's events. You cannot change other values of a webhook. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: id, body, webhookID, webhookId, +1 more.

vk_post_register_3364d6b06ae9A

Register. Raw Vikunja REST proxy for POST /register. Creates a new user account. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is not required.

Inputs: body (required).

vk_post_shares_5d6ccf52a1d9A

Get an auth token for a share. Raw Vikunja REST proxy for POST /shares/{share}/auth. Get a jwt auth token for a shared project from a share hash. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is not required.

Inputs: body (required), share.

vk_post_tasks_08322d9fc186A

Add multiple new assignees to a task. Raw Vikunja REST proxy for POST /tasks/{taskID}/assignees/bulk. Adds multiple new assignees to a task. The assignee needs to have access to the project, the doer must be able to edit this task. Every user not in the project will be unassigned from the task, pass an empty array to unassign everyone. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body (required), taskID, taskId, task_id.

vk_post_tasks_09aa3369648dA

Update a task. Raw Vikunja REST proxy for POST /tasks/{id}. Updates a task. This includes marking it as done. Assignees you pass will be updated, see their individual endpoints for more details on how this is done. To update labels, see the description of the endpoint. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body (required), id.

vk_post_tasks_2ca74cd58ce3A

Update multiple tasks. Raw Vikunja REST proxy for POST /tasks/bulk. Updates multiple tasks atomically. All provided tasks must be writable by the user. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body (required).

vk_post_tasks_7f5babc1ed99A

Update all labels on a task.. Raw Vikunja REST proxy for POST /tasks/{taskID}/labels/bulk. Updates all labels on a task. Every label which is not passed but exists on the task will be deleted. Every label which does not exist on the task will be added. All labels which are passed and already exist on the task won't be touched. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body (required), taskID, taskId, task_id.

vk_post_tasks_d0b27e4f6b1aA

Mark a task as read. Raw Vikunja REST proxy for POST /tasks/{projecttask}/read. Marks a task as read for the current user by removing the unread status entry. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body, projecttask.

vk_post_tasks_dfd791a4e932A

Update an existing task comment. Raw Vikunja REST proxy for POST /tasks/{taskID}/comments/{commentID}. Update an existing task comment. The user doing this need to have at least write access to the task this comment belongs to. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body, taskID, taskId, task_id, +3 more.

vk_post_tasks_f2d79f6a8a47B

Updates a task position. Raw Vikunja REST proxy for POST /tasks/{id}/position. Updates a task position. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body (required), id.

vk_post_teams_68a82e0c7e06A

Toggle a team member's admin status. Raw Vikunja REST proxy for POST /teams/{id}/members/{userID}/admin. If a user is team admin, this will make them member and vise-versa. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: id, body, userID, userId, +1 more.

vk_post_teams_6faf1e0edd19C

Updates a team. Raw Vikunja REST proxy for POST /teams/{id}. Updates a team. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body (required), id.

vk_post_user_07d2b46cb22fB

Request a user data export.. Raw Vikunja REST proxy for POST /user/export/request. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body (required).

vk_post_user_13df50a3da9eA

Confirm the email of a new user. Raw Vikunja REST proxy for POST /user/confirm. Confirms the email of a newly registered user. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is not required.

Inputs: body (required).

vk_post_user_1a3ddc942173A

Renew link share token. Raw Vikunja REST proxy for POST /user/token. Returns a new valid jwt link share token. Only works for link share tokens. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body.

vk_post_user_273bd04e9f7bB

Request the deletion of the user. Raw Vikunja REST proxy for POST /user/deletion/request. Requests the deletion of the current user. It will trigger an email which has to be confirmed to start the deletion. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body (required).

vk_post_user_36b98a5d1c92A

Disable totp settings. Raw Vikunja REST proxy for POST /user/settings/totp/disable. Disables any totp settings for the current user. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body (required).

vk_post_user_38ed3bdad118A

Refresh user token. Raw Vikunja REST proxy for POST /user/token/refresh. Exchanges the refresh token cookie for a new short-lived JWT. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body.

vk_post_user_394b4ec11ef6A

Change general user settings of the current user.. Raw Vikunja REST proxy for POST /user/settings/general. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body (required).

vk_post_user_3a307fd77361A

Logout. Raw Vikunja REST proxy for POST /user/logout. Destroys the current session and clears the refresh token cookie. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body.

vk_post_user_3bc5afd3077bB

Enable a previously enrolled totp setting.. Raw Vikunja REST proxy for POST /user/settings/totp/enable. Enables a previously enrolled totp setting by providing a totp passcode. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body (required).

vk_post_user_826daa0281a6A

Update email address. Raw Vikunja REST proxy for POST /user/settings/email. Lets the current user change their email address. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body (required).

vk_post_user_9cd9a3ba4e0dA

Update a user-level webhook target. Raw Vikunja REST proxy for POST /user/settings/webhooks/{id}. Update the events for a user-level webhook target. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: id, body.

vk_post_user_a8a50f03a2a2A

Enroll a user into totp. Raw Vikunja REST proxy for POST /user/settings/totp/enroll. Creates an initial setup for the user in the db. After this step, the user needs to verify they have a working totp setup with the "enable totp" endpoint. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body.

vk_post_user_ab5e5c810e91A

Set the user's avatar. Raw Vikunja REST proxy for POST /user/settings/avatar. Changes the user avatar. Valid types are gravatar (uses the user email), upload, initials, marble, ldap (synced from LDAP server), openid (synced from OpenID provider), default. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body (required).

vk_post_user_ae24dc257aa8A

Confirm a user deletion request. Raw Vikunja REST proxy for POST /user/deletion/confirm. Confirms the deletion request of a user sent via email. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is not required.

Inputs: body (required).

vk_post_user_bc424c7a6615A

Change password. Raw Vikunja REST proxy for POST /user/password. Lets the current user change its password. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body (required).

vk_post_user_c1580ed27784A

Resets a password. Raw Vikunja REST proxy for POST /user/password/reset. Resets a user email with a previously reset token. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is not required.

Inputs: body (required).

vk_post_user_c52831ed2397A

Download a user data export.. Raw Vikunja REST proxy for POST /user/export/download. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body (required).

vk_post_user_d82796ed4e87A

Abort a user deletion request. Raw Vikunja REST proxy for POST /user/deletion/cancel. Aborts an in-progress user deletion. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is not required.

Inputs: body (required).

vk_post_user_f95850f2b0f6A

Request password reset token. Raw Vikunja REST proxy for POST /user/password/token. Requests a token to reset a users password. The token is sent via email. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is not required.

Inputs: body (required).

vk_put_filters_dac0a4e19aa2B

Creates a new saved filter. Raw Vikunja REST proxy for PUT /filters. Creates a new saved filter Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body.

vk_put_kind_a908298e0dacA

Add a reaction to an entity. Raw Vikunja REST proxy for PUT /{kind}/{id}/reactions. Add a reaction to an entity. Will do nothing if the reaction already exists. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body (required), id, kind.

vk_put_labels_579a24596e31A

Update a label. Raw Vikunja REST proxy for PUT /labels/{id}. Update an existing label. The user needs to be the creator of the label to be able to do this. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body (required), id.

vk_put_labels_de9ad1e5fe26C

Create a label. Raw Vikunja REST proxy for PUT /labels. Creates a new label. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body (required).

vk_put_migratio_49ef754325c0A

Import all projects, tasks etc. from a WeKan board export. Raw Vikunja REST proxy for PUT /migration/wekan/migrate. Imports all projects, tasks, labels, checklists, comments, and attachments from a WeKan board JSON export into Vikunja. Pass multipart form data in the form field. File values use an object with filename, contentBase64 and optional contentType. Multi-file fields accept arrays. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Form fields: import. Required: import. Authentication is required.

Inputs: form (required).

vk_put_migratio_97425315f880A

Import CSV file. Raw Vikunja REST proxy for PUT /migration/csv/migrate. Imports tasks from a CSV file into Vikunja with the provided configuration. Pass multipart form data in the form field. File values use an object with filename, contentBase64 and optional contentType. Multi-file fields accept arrays. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Form fields: import, config. Required: import, config. Authentication is required.

Inputs: form (required).

vk_put_migratio_991857c055fbA

Preview CSV import. Raw Vikunja REST proxy for PUT /migration/csv/preview. Generates a preview of the first 5 tasks that would be imported with the given configuration. Pass multipart form data in the form field. File values use an object with filename, contentBase64 and optional contentType. Multi-file fields accept arrays. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Form fields: import, config. Required: import, config. Authentication is required.

Inputs: form (required).

vk_put_migratio_99c1d32d8e3aA

Detect CSV structure. Raw Vikunja REST proxy for PUT /migration/csv/detect. Analyzes a CSV file and returns auto-detected columns, delimiter, quote character, and date format with suggested column mappings. Pass multipart form data in the form field. File values use an object with filename, contentBase64 and optional contentType. Multi-file fields accept arrays. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Form fields: import. Required: import. Authentication is required.

Inputs: form (required).

vk_put_migratio_da506ec8aeb9A

Import all projects, tasks etc. from a TickTick backup export. Raw Vikunja REST proxy for PUT /migration/ticktick/migrate. Imports all projects, tasks, notes, reminders, subtasks and files from a TickTick backup export into Vikunja. Pass multipart form data in the form field. File values use an object with filename, contentBase64 and optional contentType. Multi-file fields accept arrays. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Form fields: import. Required: import. Authentication is required.

Inputs: form (required).

vk_put_projects_18c03cfa3b5aA

Create a project view. Raw Vikunja REST proxy for PUT /projects/{project}/views. Create a project view in a specific project. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body (required), project.

vk_put_projects_53585a63b2d6A

Upload a project background. Raw Vikunja REST proxy for PUT /projects/{id}/backgrounds/upload. Upload a project background. Pass multipart form data in the form field. File values use an object with filename, contentBase64 and optional contentType. Multi-file fields accept arrays. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Form fields: background. Required: background. Authentication is required.

Inputs: form (required), id.

vk_put_projects_60535a93f674A

Duplicate an existing project. Raw Vikunja REST proxy for PUT /projects/{projectID}/duplicate. Copies the project, tasks, files, kanban data, assignees, comments, attachments, labels, relations, backgrounds, user/team permissions and link shares from one project to a new one. The user needs read access in the project and write access in the parent of the new project. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body (required), projectID, projectId, project_id.

vk_put_projects_84202ffc7ce2A

Add a user to a project. Raw Vikunja REST proxy for PUT /projects/{id}/users. Gives a user access to a project. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body (required), id.

vk_put_projects_8e01c442b6a8A

Create a webhook target. Raw Vikunja REST proxy for PUT /projects/{id}/webhooks. Create a webhook target which receives POST requests about specified events from a project. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body (required), id.

vk_put_projects_90ea1375caf6B

Add a team to a project. Raw Vikunja REST proxy for PUT /projects/{id}/teams. Gives a team access to a project. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body (required), id.

vk_put_projects_9c800bbf1cb8A

Creates a new project. Raw Vikunja REST proxy for PUT /projects. Creates a new project. If a parent project is provided the user needs to have write access to that project. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body (required).

vk_put_projects_d6723872edddB

Share a project via link. Raw Vikunja REST proxy for PUT /projects/{project}/shares. Share a project via link. The user needs to have write-access to the project to be able do this. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body (required), project.

vk_put_projects_e1453aec58d3A

Create a new bucket. Raw Vikunja REST proxy for PUT /projects/{id}/views/{view}/buckets. Creates a new kanban bucket on a project. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body (required), id, view.

vk_put_projects_f6b76ac673f7B

Create a task. Raw Vikunja REST proxy for PUT /projects/{id}/tasks. Inserts a task into a project. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body (required), id.

vk_put_subscrip_4a35be590f51B

Subscribes the current user to an entity.. Raw Vikunja REST proxy for PUT /subscriptions/{entity}/{entityID}. Subscribes the current user to an entity. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body, entity, entityID, entityId, +1 more.

vk_put_tasks_0c5b4fde0cccA

Duplicate a task. Raw Vikunja REST proxy for PUT /tasks/{taskID}/duplicate. Copies a task with all its properties (labels, assignees, attachments, reminders) into the same project. Creates a "copied from" relation between the new and original task. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body, taskID, taskId, task_id.

vk_put_tasks_2121c1502275A

Add a new assignee to a task. Raw Vikunja REST proxy for PUT /tasks/{taskID}/assignees. Adds a new assignee to a task. The assignee needs to have access to the project, the doer must be able to edit this task. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body (required), taskID, taskId, task_id.

vk_put_tasks_25d391326d4fA

Upload a task attachment. Raw Vikunja REST proxy for PUT /tasks/{id}/attachments. Upload a task attachment. You can pass multiple files with the files form param. Pass multipart form data in the form field. File values use an object with filename, contentBase64 and optional contentType. Multi-file fields accept arrays. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Form fields: files. Required: files. Authentication is required.

Inputs: form (required), id.

vk_put_tasks_5a1099bfe4b5B

Add a label to a task. Raw Vikunja REST proxy for PUT /tasks/{task}/labels. Add a label to a task. The user needs to have write-access to the project to be able do this. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body (required), task.

vk_put_tasks_6293a01ae4e2A

Create a new relation between two tasks. Raw Vikunja REST proxy for PUT /tasks/{taskID}/relations. Creates a new relation between two tasks. The user needs to have update permissions on the base task and at least read permissions on the other task. Both tasks do not need to be on the same project. Take a look at the docs for available task relation kinds. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body (required), taskID, taskId, task_id.

vk_put_tasks_8a9c7a6241a6A

Create a new task comment. Raw Vikunja REST proxy for PUT /tasks/{taskID}/comments. Create a new task comment. The user doing this need to have at least write access to the task this comment should belong to. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body (required), taskID, taskId, task_id.

vk_put_teams_05543c7af562B

Add a user to a team. Raw Vikunja REST proxy for PUT /teams/{id}/members. Add a user to a team. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body (required), id.

vk_put_teams_dd5552eb152cC

Creates a new team. Raw Vikunja REST proxy for PUT /teams. Creates a new team. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body (required).

vk_put_tokens_3408c99d9d37B

Create a new api token. Raw Vikunja REST proxy for PUT /tokens. Create a new api token to use on behalf of the user creating it. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body (required).

vk_put_user_05b2c0bba8e2A

Upload a user avatar. Raw Vikunja REST proxy for PUT /user/settings/avatar/upload. Upload a user avatar. This will also set the user's avatar provider to "upload" Pass multipart form data in the form field. File values use an object with filename, contentBase64 and optional contentType. Multi-file fields accept arrays. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Form fields: avatar. Required: avatar. Authentication is required.

Inputs: form (required).

vk_put_user_469503905adbA

Generate a caldav token. Raw Vikunja REST proxy for PUT /user/settings/token/caldav. Generates a caldav token which can be used for the caldav api. It is not possible to see the token again after it was generated. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body.

vk_put_user_4bf967c71ca3A

Create a user-level webhook target. Raw Vikunja REST proxy for PUT /user/settings/webhooks. Create a webhook target for the current user that receives events across all projects. Pass the JSON request payload in the optional body field. Path and query parameters are top-level fields. Original parameter names also accept camelCase and snake_case aliases. Authentication is required.

Inputs: body (required).

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

Loading tool schema changelog…

    TDQS

    C2.9/5.0

    Scored across 180 tools

    Disambiguation1/5

    The tool set contains extensive overlap: curated tools like vikunja_get_project and vikunja_delete_task duplicate raw proxies such as vk_get_projects_25ac8903752b and vk_delete_tasks_88ea47d49817. Many raw proxies have generic names with random hex suffixes (e.g., vk_get_projects_*), and placeholders like vk_get_kind_* make it impossible to distinguish purposes. Agents will struggle to select the correct tool among dozens of near-identical options.

    Naming Consistency1/5

    Naming follows no uniform pattern: there is a mix of vikunja_* (verb_noun) and vk_* (http_verb_entity_randomhash) prefixes, with some tools using different verbs (get/delete/put/post) and inconsistent object ordering. The random hash suffixes on raw proxies make names unpredictable and hard to memorize. The overall style is chaotic and lacks any consistent convention.

    Tool Count1/5

    With 180 tools, this server is drastically over-scoped for an MCP integration. Even if the raw proxies are auto-generated, exposing every endpoint as a separate tool creates overwhelming selection burden and token bloat. A well-designed MCP server would typically expose 10-20 curated tools, not hundreds of raw HTTP proxies.

    Completeness4/5

    The sheer number of raw proxies means nearly every Vikunja API endpoint is represented, covering projects, tasks, labels, comments, attachments, teams, users, webhooks, subscriptions, and migrations. However, the curated subset lacks some high-level CRUD operations (e.g., update/delete labels or comments) which forces agents to use the obscure raw proxies. The domain is broadly covered but not cohesively organized.

    Maintenance

    ActivityMaintained
    ResponsivenessNo recent community issues

    Related MCP Connectors

    Related MCP Servers

    • A
      license
      B
      quality
      D
      maintenance
      Enables interaction with Vikunja task management instances through natural language. Supports comprehensive project and task operations including CRUD, assignments, labels, comments, relations, and attachments.
      33
      2
      MIT
    • A
      license
      Not graded
      quality
      D
      maintenance
      Connects Claude to self-hosted Vikunja instances for conversational task and project management. Supports CRUD operations on projects and tasks, plus labels, comments, weekly reviews, calendar feeds, and task relations.
      -