# Vikunja

This recipe generates the `vikunja` CLI and agent Skill for
[Vikunja](https://github.com/go-vikunja/vikunja) tasks, projects, labels,
teams, and users.

## API and authentication

Create a Vikunja API token:

```sh
vikunja auth login --hostname <host>
vikunja auth status --hostname <host>
```

The token is sent as a bearer credential and checked against the current-user
endpoint.

## Install the Skill

```sh
vikunja skill install --scope user --agent codex --yes
```

## Agent workflow

```sh
vikunja commands --json
vikunja search "get user information" --json
```

Use the returned command path with `vikunja commands show` before execution.
Bump the pin in `specs/sources.yaml` when upgrading the Vikunja API.

cli:
  name: vikunja
  short: "Command-line tool for Vikunja project management"

skill:
  bundle: true

auth:
  validate:
    method: GET
    path: /api/v1/user
    display:
      username_field: username
      fallback_field: email

name: vikunja
display_name: Vikunja
cli_name: vikunja
category: project-management
homepage: https://github.com/go-vikunja/vikunja
description: Generated Vikunja CLI and agent Skill for tasks, projects, teams, and users.
maintainers:
  - github: samzong
auth:
  type: bearer
  notes: >-
    Requires a Vikunja API token in the Authorization header. Run
    `vikunja auth login --hostname <host>` and verify it with
    `vikunja auth status --hostname <host>`.
smoke:
  intent: get user information
  expect: get-user

sources:
  vikunja_api:
    default_hostname: localhost:3456
    repo_url: https://github.com/go-vikunja/vikunja
    # pinned to main HEAD as of 2026-07-26; bump when upgrading
    pinned_tag: c0f026ff47295951ce63498e6e42542f1a1ecd34
    backend: swagger
    swagger:
      files:
        - pkg/swagger/swagger.json

generated by lathe codegen; safe to remove and regenerate

---
name: vikunja
description: >
  Use when operating the vikunja generated CLI. Discover commands, inspect parameters,
  check auth state, and execute API operations safely.
---

# vikunja CLI

Use this skill when a user asks you to operate `vikunja`, inspect its API commands, or find the right generated command for an API task.

## Workflow

1. Search for candidates with `vikunja search "<intent>" --json`; use `--limit` when needed. Search is only candidate discovery.
2. Inspect the exact command with `vikunja commands show <path...> --json` before executing an unfamiliar command.
3. If the command detail has `auth.required=true`, run `vikunja auth status --hostname <host>` before execution. Use `http.default_hostname` when present unless the user provides `--hostname` or `$VIKUNJA_HOST`.
4. Execute only after flags, body, auth, HTTP path, and output hints are clear from `commands show`.

## General Commands

- `vikunja commands --json`: full generated command catalog.
- `vikunja commands --include-hidden --json`: include hidden generated commands.
- `vikunja commands show <path...> --json`: source of truth for one command.
- `vikunja commands schema --json`: catalog schema version for parser compatibility.
- `vikunja search "<intent>" --json`: ranked candidate commands.

## Maintenance Commands

- `vikunja --version` or `vikunja -v`: print CLI build version.

## References

- Read `references/catalog.md` for the command discovery protocol and catalog field meanings.
- Read `references/modules/vikunja-api.md` for the `vikunja_api` module command index.

## Rules

- Do not guess flags or request body shape from command names.
- Do not execute directly from search results; confirm with `commands show` first.
- Prefer `-o json` for machine-readable command output unless the user asks for human-readable output.
- Use `--file`, `--set`, or `--set-str` for JSON request bodies according to `commands show` body requirements.
- For sensitive flags, prefer safe modes from `flags[].input_modes`: `--<flag>-env`, `--<flag>-file`, or `--<flag>-stdin`.

interface:
  display_name: "vikunja CLI"
  short_description: "Use the vikunja generated CLI"
  default_prompt: "Use $vikunja to find and run the right vikunja command."

# Catalog Protocol

Use the runtime catalog as the source of truth. Generated references are a fast index; command execution details come from the CLI itself.

## Search

Run `vikunja search "<intent>" --json` to find candidate commands. Use `--limit` to control result count. Treat search output as candidates only.

## Full Catalog

Run `vikunja commands --json` to inspect the generated command catalog. Use `--include-hidden` only when hidden commands are relevant.

Key fields:

- `path`: command path to pass to `commands show` or execute after the CLI name.
- `shortcuts`: root-level commands that execute the same operation with preset flag values.
- `http`: HTTP method and path template.
- `http.default_hostname`: optional source-level host selected after explicit `--hostname` and `$VIKUNJA_HOST`; when present it is used before the single-host fallback from `hosts.yml`.
- `flags`: CLI flags, parameter location, type, required state, defaults, enum values, format, input modes, and help.
- `body`: request body requirement and media type.
- `auth`: whether auth is required and which scopes are declared.
- `examples`: runnable examples with optional body shape, output hints, and follow-up commands.
- `output`: list path, default columns, response media type, pagination, and streaming hints.
- `notes`, `prerequisites`, and `known_errors`: overlay-provided operation context that is not inferred from the API spec.

## Command Detail

Run `vikunja commands show <path...> --json` before executing an unfamiliar command. This is the source of truth for flags, body, auth, HTTP path, and output hints.

## Schema

Run `vikunja commands schema --json` to read the catalog schema version before parsing catalog JSON with durable tooling.

## Sensitive Flags

When a flag entry has `input_modes`, prefer safe modes over putting secrets directly in shell arguments.

- `flag`: pass the direct `--<flag>` value; keep this for compatibility or non-secret values.
- `env`: pass `--<flag>-env NAME` to read the value from an environment variable.
- `file`: pass `--<flag>-file path` to read the value from a file.
- `stdin`: pass `--<flag>-stdin` to read the value from stdin.
- Use only one input mode for the same flag.

## Request Bodies

- `--file path`: read a JSON body from a file.
- `--file -`: read a JSON body from stdin.
- `--set key.path=value`: build JSON with type inference for booleans, null, integers, and floats.
- `--set-str key.path=value`: build JSON while forcing the value to remain a string.

## Output

Use `-o json` for machine-readable command output. Other supported formats are `table`, `yaml`, and `raw`.

## Auth

If command detail returns `auth.required=true`, run `vikunja auth status --hostname <host>` before execution. Use `http.default_hostname` when present unless the user provides `--hostname` or `$VIKUNJA_HOST`; if no matching host is logged in, stop and ask the user to authenticate.

# Module `vikunja_api`

## Source

- Backend: `swagger`
- Default hostname: `localhost:3456`
- Repository: https://github.com/go-vikunja/vikunja
- Pinned tag: `c0f026ff47295951ce63498e6e42542f1a1ecd34`
- Files: `pkg/swagger/swagger.json`
- Resolved SHA: `c0f026ff47295951ce63498e6e42542f1a1ecd34`

## admin

### `vikunja vikunja_api admin delete-admin-users-id`

- Summary: Delete a user (admin)
- HTTP: `DELETE /admin/users/{id}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): User ID
  - `--mode` (query): Deletion mode: 'now' for immediate deletion, 'scheduled' (default) to trigger the email-confirmation self-deletion flow.
- Output: response media `application/json`

### `vikunja vikunja_api admin get-admin-overview`

- Summary: Admin overview
- HTTP: `GET /admin/overview`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

### `vikunja vikunja_api admin get-admin-projects`

- Summary: List projects (admin)
- HTTP: `GET /admin/projects`
- Auth: required
- Body: none
- Flags:
  - `--page` (query): Page number, defaults to 1.
  - `--per_page` (query): Items per page, defaults to the service setting.
  - `--s` (query): Search projects by title, description or identifier.
- Output: columns `id`, `background_blur_hash`, `background_information`, `created`, `description`, `hex_color`; response media `application/json`; pagination `offset`

### `vikunja vikunja_api admin get-admin-users`

- Summary: List users (admin)
- HTTP: `GET /admin/users`
- Auth: required
- Body: none
- Flags:
  - `--s` (query): Search string matched against username and email.
  - `--page` (query): Page number, defaults to 1.
  - `--per_page` (query): Items per page, defaults to the service setting.
- Output: columns `name`, `id`, `auth_provider`, `bot_owner_id`, `created`, `email`; response media `application/json`; pagination `offset`

### `vikunja vikunja_api admin patch-admin-projects-id-owner`

- Summary: Reassign project owner (admin)
- HTTP: `PATCH /admin/projects/{id}/owner`
- Auth: required
- Body: required
- Flags:
  - `--id` (path, required): Project ID
- Output: list path `views`; columns `id`, `bucket_configuration_mode`, `created`, `default_bucket_id`, `done_bucket_id`, `filter`; response media `application/json`

### `vikunja vikunja_api admin patch-admin-users-id-admin`

- Summary: Promote or demote a user (admin)
- HTTP: `PATCH /admin/users/{id}/admin`
- Auth: required
- Body: required
- Flags:
  - `--id` (path, required): User ID
- Output: response media `application/json`

### `vikunja vikunja_api admin patch-admin-users-id-status`

- Summary: Set a user's status (admin)
- HTTP: `PATCH /admin/users/{id}/status`
- Auth: required
- Body: required
- Flags:
  - `--id` (path, required): User ID
- Output: response media `application/json`

### `vikunja vikunja_api admin post-admin-users`

- Summary: Create a user (admin)
- HTTP: `POST /admin/users`
- Auth: required
- Body: required
- Flags: none
- Output: response media `application/json`

## api

### `vikunja vikunja_api api delete-tokens-token-id`

- Summary: Deletes an existing api token
- HTTP: `DELETE /tokens/{tokenID}`
- Auth: required
- Body: none
- Flags:
  - `--token-id` (path, required): Token ID
- Output: response media `application/json`

### `vikunja vikunja_api api get-routes`

- Summary: Get a list of all token api routes
- HTTP: `GET /routes`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

### `vikunja vikunja_api api get-tokens`

- Summary: Get all api tokens of the current user
- HTTP: `GET /tokens`
- Auth: required
- Body: none
- Flags:
  - `--page` (query): The page number, used for pagination. If not provided, the first page of results is returned.
  - `--per_page` (query): The maximum number of tokens per page. This parameter is limited by the configured maximum of items per page.
  - `--s` (query): Search tokens by their title.
- Output: columns `id`, `created`, `expires_at`, `owner_id`, `permissions`, `title`; response media `application/json`; pagination `offset`

### `vikunja vikunja_api api put-tokens`

- Summary: Create a new api token
- HTTP: `PUT /tokens`
- Auth: required
- Body: required
- Flags: none
- Output: response media `application/json`

## assignees

### `vikunja vikunja_api assignees delete-tasks-task-id-assignees-user-id`

- Summary: Delete an assignee
- HTTP: `DELETE /tasks/{taskID}/assignees/{userID}`
- Auth: required
- Body: none
- Flags:
  - `--task-id` (path, required): Task ID
  - `--user-id` (path, required): Assignee user ID
- Output: response media `application/json`

### `vikunja vikunja_api assignees get-tasks-task-id-assignees`

- Summary: Get all assignees for a task
- HTTP: `GET /tasks/{taskID}/assignees`
- Auth: required
- Body: none
- Flags:
  - `--page` (query): The page number. Used for pagination. If not provided, the first page of results is returned.
  - `--per_page` (query): The maximum number of items per page. Note this parameter is limited by the configured maximum of items per page.
  - `--s` (query): Search assignees by their username.
  - `--task-id` (path, required): Task ID
- Output: columns `name`, `id`, `bot_owner_id`, `created`, `email`, `updated`; response media `application/json`; pagination `offset`

### `vikunja vikunja_api assignees post-tasks-task-id-assignees-bulk`

- Summary: Add multiple new assignees to a task
- HTTP: `POST /tasks/{taskID}/assignees/bulk`
- Auth: required
- Body: required
- Flags:
  - `--task-id` (path, required): Task ID
- Output: response media `application/json`

### `vikunja vikunja_api assignees put-tasks-task-id-assignees`

- Summary: Add a new assignee to a task
- HTTP: `PUT /tasks/{taskID}/assignees`
- Auth: required
- Body: required
- Flags:
  - `--task-id` (path, required): Task ID
- Output: response media `application/json`

## auth

### `vikunja vikunja_api auth get-token-openid`

- Summary: Authenticate a user with OpenID Connect
- HTTP: `POST /auth/openid/{provider}/callback`
- Auth: required
- Body: required
- Flags:
  - `--provider` (path, required): The OpenID Connect provider key as returned by the /info endpoint
- Output: response media `application/json`

### `vikunja vikunja_api auth post-login`

- Summary: Login
- HTTP: `POST /login`
- Auth: required
- Body: required
- Flags: none
- Output: response media `application/json`

### `vikunja vikunja_api auth post-register`

- Summary: Register
- HTTP: `POST /register`
- Auth: required
- Body: required
- Flags: none
- Output: response media `application/json`

### `vikunja vikunja_api auth post-user-logout`

- Summary: Logout
- HTTP: `POST /user/logout`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

### `vikunja vikunja_api auth post-user-token`

- Summary: Renew link share token
- HTTP: `POST /user/token`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

### `vikunja vikunja_api auth post-user-token-refresh`

- Summary: Refresh user token
- HTTP: `POST /user/token/refresh`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

## filter

### `vikunja vikunja_api filter delete-filters-id`

- Summary: Removes a saved filter
- HTTP: `DELETE /filters/{id}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): Filter ID
- Output: response media `application/json`

### `vikunja vikunja_api filter get-filters-id`

- Summary: Gets one saved filter
- HTTP: `GET /filters/{id}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): Filter ID
- Output: response media `application/json`

### `vikunja vikunja_api filter post-filters-id`

- Summary: Updates a saved filter
- HTTP: `POST /filters/{id}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): Filter ID
- Output: response media `application/json`

### `vikunja vikunja_api filter put-filters`

- Summary: Creates a new saved filter
- HTTP: `PUT /filters`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

## labels

### `vikunja vikunja_api labels delete-labels-id`

- Summary: Delete a label
- HTTP: `DELETE /labels/{id}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): Label ID
- Output: response media `application/json`

### `vikunja vikunja_api labels delete-tasks-task-labels-label`

- Summary: Remove a label from a task
- HTTP: `DELETE /tasks/{task}/labels/{label}`
- Auth: required
- Body: none
- Flags:
  - `--task` (path, required): Task ID
  - `--label` (path, required): Label ID
- Output: response media `application/json`

### `vikunja vikunja_api labels get-labels`

- Summary: Get all labels a user has access to
- HTTP: `GET /labels`
- Auth: required
- Body: none
- Flags:
  - `--page` (query): The page number. Used for pagination. If not provided, the first page of results is returned.
  - `--per_page` (query): The maximum number of items per page. Note this parameter is limited by the configured maximum of items per page.
  - `--s` (query): Search labels by label text.
- Output: columns `id`, `created`, `created_by`, `description`, `hex_color`, `title`; response media `application/json`; pagination `offset`

### `vikunja vikunja_api labels get-labels-id`

- Summary: Gets one label
- HTTP: `GET /labels/{id}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): Label ID
- Output: response media `application/json`

### `vikunja vikunja_api labels get-tasks-task-labels`

- Summary: Get all labels on a task
- HTTP: `GET /tasks/{task}/labels`
- Auth: required
- Body: none
- Flags:
  - `--task` (path, required): Task ID
  - `--page` (query): The page number. Used for pagination. If not provided, the first page of results is returned.
  - `--per_page` (query): The maximum number of items per page. Note this parameter is limited by the configured maximum of items per page.
  - `--s` (query): Search labels by label text.
- Output: columns `id`, `created`, `created_by`, `description`, `hex_color`, `title`; response media `application/json`; pagination `offset`

### `vikunja vikunja_api labels post-tasks-task-id-labels-bulk`

- Summary: Update all labels on a task.
- HTTP: `POST /tasks/{taskID}/labels/bulk`
- Auth: required
- Body: required
- Flags:
  - `--task-id` (path, required): Task ID
- Output: response media `application/json`

### `vikunja vikunja_api labels put-labels`

- Summary: Create a label
- HTTP: `PUT /labels`
- Auth: required
- Body: required
- Flags: none
- Output: response media `application/json`

### `vikunja vikunja_api labels put-labels-id`

- Summary: Update a label
- HTTP: `PUT /labels/{id}`
- Auth: required
- Body: required
- Flags:
  - `--id` (path, required): Label ID
- Output: response media `application/json`

### `vikunja vikunja_api labels put-tasks-task-labels`

- Summary: Add a label to a task
- HTTP: `PUT /tasks/{task}/labels`
- Auth: required
- Body: required
- Flags:
  - `--task` (path, required): Task ID
- Output: response media `application/json`

## migration

### `vikunja vikunja_api migration get-migration-csv-status`

- Summary: Get CSV migration status
- HTTP: `GET /migration/csv/status`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

### `vikunja vikunja_api migration get-migration-microsoft-todo-auth`

- Summary: Get the auth url from Microsoft Todo
- HTTP: `GET /migration/microsoft-todo/auth`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

### `vikunja vikunja_api migration get-migration-microsoft-todo-status`

- Summary: Get migration status
- HTTP: `GET /migration/microsoft-todo/status`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

### `vikunja vikunja_api migration get-migration-ticktick-status`

- Summary: Get migration status
- HTTP: `GET /migration/ticktick/status`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

### `vikunja vikunja_api migration get-migration-todoist-auth`

- Summary: Get the auth url from todoist
- HTTP: `GET /migration/todoist/auth`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

### `vikunja vikunja_api migration get-migration-todoist-status`

- Summary: Get migration status
- HTTP: `GET /migration/todoist/status`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

### `vikunja vikunja_api migration get-migration-trello-auth`

- Summary: Get the auth url from trello
- HTTP: `GET /migration/trello/auth`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

### `vikunja vikunja_api migration get-migration-trello-status`

- Summary: Get migration status
- HTTP: `GET /migration/trello/status`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

### `vikunja vikunja_api migration get-migration-vikunja-file-status`

- Summary: Get migration status
- HTTP: `GET /migration/vikunja-file/status`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

### `vikunja vikunja_api migration get-migration-wekan-status`

- Summary: Get migration status
- HTTP: `GET /migration/wekan/status`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

### `vikunja vikunja_api migration post-migration-microsoft-todo-migrate`

- Summary: Migrate all projects, tasks etc. from Microsoft Todo
- HTTP: `POST /migration/microsoft-todo/migrate`
- Auth: required
- Body: required
- Flags: none
- Output: response media `application/json`

### `vikunja vikunja_api migration post-migration-todoist-migrate`

- Summary: Migrate all lists, tasks etc. from todoist
- HTTP: `POST /migration/todoist/migrate`
- Auth: required
- Body: required
- Flags: none
- Output: response media `application/json`

### `vikunja vikunja_api migration post-migration-trello-migrate`

- Summary: Migrate all projects, tasks etc. from trello
- HTTP: `POST /migration/trello/migrate`
- Auth: required
- Body: required
- Flags: none
- Output: response media `application/json`

### `vikunja vikunja_api migration post-migration-vikunja-file-migrate`

- Summary: Import all projects, tasks etc. from a Vikunja data export
- HTTP: `POST /migration/vikunja-file/migrate`
- Auth: required
- Body: none
- Flags:
  - `--import` (formData, required): The Vikunja export zip file.
- Output: response media `application/json`

### `vikunja vikunja_api migration put-migration-csv-detect`

- Summary: Detect CSV structure
- HTTP: `PUT /migration/csv/detect`
- Auth: required
- Body: none
- Flags:
  - `--import` (formData, required): The CSV file to analyze
- Output: list path `columns`; response media `application/json`

### `vikunja vikunja_api migration put-migration-csv-migrate`

- Summary: Import CSV file
- HTTP: `PUT /migration/csv/migrate`
- Auth: required
- Body: none
- Flags:
  - `--import` (formData, required): The CSV file to import
  - `--config` (formData, required): The import configuration JSON
- Output: response media `application/json`

### `vikunja vikunja_api migration put-migration-csv-preview`

- Summary: Preview CSV import
- HTTP: `PUT /migration/csv/preview`
- Auth: required
- Body: none
- Flags:
  - `--import` (formData, required): The CSV file to preview
  - `--config` (formData, required): The import configuration JSON
- Output: list path `tasks`; columns `description`, `done`, `due_date`, `end_date`, `priority`, `project`; response media `application/json`

### `vikunja vikunja_api migration put-migration-ticktick-migrate`

- Summary: Import all projects, tasks etc. from a TickTick backup export
- HTTP: `PUT /migration/ticktick/migrate`
- Auth: required
- Body: none
- Flags:
  - `--import` (formData, required): The TickTick backup csv file.
- Output: response media `application/json`

### `vikunja vikunja_api migration put-migration-wekan-migrate`

- Summary: Import all projects, tasks etc. from a WeKan board export
- HTTP: `PUT /migration/wekan/migrate`
- Auth: required
- Body: none
- Flags:
  - `--import` (formData, required): The WeKan board JSON export file.
- Output: response media `application/json`

## project

### `vikunja vikunja_api project delete-projects-id`

- Summary: Deletes a project
- HTTP: `DELETE /projects/{id}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): Project ID
- Output: response media `application/json`

### `vikunja vikunja_api project delete-projects-id-background`

- Summary: Remove a project background
- HTTP: `DELETE /projects/{id}/background`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): Project ID
- Output: list path `views`; columns `id`, `bucket_configuration_mode`, `created`, `default_bucket_id`, `done_bucket_id`, `filter`; response media `application/json`

### `vikunja vikunja_api project delete-projects-project-id-views-view-buckets-bucket-id`

- Summary: Deletes an existing bucket
- HTTP: `DELETE /projects/{projectID}/views/{view}/buckets/{bucketID}`
- Auth: required
- Body: none
- Flags:
  - `--project-id` (path, required): Project Id
  - `--bucket-id` (path, required): Bucket Id
  - `--view` (path, required): Project view ID
- Output: response media `application/json`

### `vikunja vikunja_api project delete-projects-project-views-id`

- Summary: Delete a project view
- HTTP: `DELETE /projects/{project}/views/{id}`
- Auth: required
- Body: none
- Flags:
  - `--project` (path, required): Project ID
  - `--id` (path, required): Project View ID
- Output: response media `application/json`

### `vikunja vikunja_api project get-backgrounds-unsplash-image-image`

- Summary: Get an unsplash image
- HTTP: `GET /backgrounds/unsplash/image/{image}`
- Auth: required
- Body: none
- Flags:
  - `--image` (path, required): Unsplash Image ID
- Output: response media `application/octet-stream`

### `vikunja vikunja_api project get-backgrounds-unsplash-image-image-thumb`

- Summary: Get an unsplash thumbnail image
- HTTP: `GET /backgrounds/unsplash/image/{image}/thumb`
- Auth: required
- Body: none
- Flags:
  - `--image` (path, required): Unsplash Image ID
- Output: response media `application/octet-stream`

### `vikunja vikunja_api project get-backgrounds-unsplash-search`

- Summary: Search for a background from unsplash
- HTTP: `GET /backgrounds/unsplash/search`
- Auth: required
- Body: none
- Flags:
  - `--s` (query): Search backgrounds from unsplash with this search term.
  - `--p` (query): The page number. Used for pagination. If not provided, the first page of results is returned.
- Output: columns `id`, `blur_hash`, `info`, `thumb`, `url`; response media `application/json`

### `vikunja vikunja_api project get-projects`

- Summary: Get all projects a user has access to
- HTTP: `GET /projects`
- Auth: required
- Body: none
- Flags:
  - `--page` (query): The page number. Used for pagination. If not provided, the first page of results is returned.
  - `--per_page` (query): The maximum number of items per page. Note this parameter is limited by the configured maximum of items per page.
  - `--s` (query): Search projects by title.
  - `--is_archived` (query): If true, also returns all archived projects.
  - `--expand` (query): If set to `permissions`, Vikunja will return the max permission the current user has on this project. You can currently only set this to `permissions`.
- Output: columns `id`, `background_blur_hash`, `background_information`, `created`, `description`, `hex_color`; response media `application/json`; pagination `offset`

### `vikunja vikunja_api project get-projects-id`

- Summary: Gets one project
- HTTP: `GET /projects/{id}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): Project ID
- Output: list path `views`; columns `id`, `bucket_configuration_mode`, `created`, `default_bucket_id`, `done_bucket_id`, `filter`; response media `application/json`

### `vikunja vikunja_api project get-projects-id-background`

- Summary: Get the project background
- HTTP: `GET /projects/{id}/background`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): Project ID
- Output: response media `application/octet-stream`

### `vikunja vikunja_api project get-projects-id-projectusers`

- Summary: Get users
- HTTP: `GET /projects/{id}/projectusers`
- Auth: required
- Body: none
- Flags:
  - `--s` (query): Search for a user by its name.
  - `--id` (path, required): Project ID
- Output: columns `name`, `id`, `bot_owner_id`, `created`, `email`, `updated`; response media `application/json`

### `vikunja vikunja_api project get-projects-id-views-view-buckets`

- Summary: Get all kanban buckets of a project
- HTTP: `GET /projects/{id}/views/{view}/buckets`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): Project ID
  - `--view` (path, required): Project view ID
- Output: columns `id`, `count`, `created`, `created_by`, `limit`, `position`; response media `application/json`

### `vikunja vikunja_api project get-projects-project-views`

- Summary: Get all project views for a project
- HTTP: `GET /projects/{project}/views`
- Auth: required
- Body: none
- Flags:
  - `--project` (path, required): Project ID
- Output: columns `id`, `bucket_configuration_mode`, `created`, `default_bucket_id`, `done_bucket_id`, `filter`; response media `application/json`

### `vikunja vikunja_api project get-projects-project-views-id`

- Summary: Get one project view
- HTTP: `GET /projects/{project}/views/{id}`
- Auth: required
- Body: none
- Flags:
  - `--project` (path, required): Project ID
  - `--id` (path, required): Project View ID
- Output: list path `bucket_configuration`; columns `title`; response media `application/json`

### `vikunja vikunja_api project post-projects-id`

- Summary: Updates a project
- HTTP: `POST /projects/{id}`
- Auth: required
- Body: required
- Flags:
  - `--id` (path, required): Project ID
- Output: list path `views`; columns `id`, `bucket_configuration_mode`, `created`, `default_bucket_id`, `done_bucket_id`, `filter`; response media `application/json`

### `vikunja vikunja_api project post-projects-id-backgrounds-unsplash`

- Summary: Set an unsplash photo as project background
- HTTP: `POST /projects/{id}/backgrounds/unsplash`
- Auth: required
- Body: required
- Flags:
  - `--id` (path, required): Project ID
- Output: list path `views`; columns `id`, `bucket_configuration_mode`, `created`, `default_bucket_id`, `done_bucket_id`, `filter`; response media `application/json`

### `vikunja vikunja_api project post-projects-project-id-views-view-buckets-bucket-id`

- Summary: Update an existing bucket
- HTTP: `POST /projects/{projectID}/views/{view}/buckets/{bucketID}`
- Auth: required
- Body: required
- Flags:
  - `--project-id` (path, required): Project Id
  - `--bucket-id` (path, required): Bucket Id
  - `--view` (path, required): Project view ID
- Output: list path `tasks`; columns `id`, `bucket_id`, `comment_count`, `cover_image_attachment_id`, `created`, `created_by`; response media `application/json`

### `vikunja vikunja_api project post-projects-project-views-id`

- Summary: Updates a project view
- HTTP: `POST /projects/{project}/views/{id}`
- Auth: required
- Body: required
- Flags:
  - `--project` (path, required): Project ID
  - `--id` (path, required): Project View ID
- Output: list path `bucket_configuration`; columns `title`; response media `application/json`

### `vikunja vikunja_api project put-projects`

- Summary: Creates a new project
- HTTP: `PUT /projects`
- Auth: required
- Body: required
- Flags: none
- Output: response media `application/json`

### `vikunja vikunja_api project put-projects-id-backgrounds-upload`

- Summary: Upload a project background
- HTTP: `PUT /projects/{id}/backgrounds/upload`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): Project ID
  - `--background` (formData, required): The file as single file.
- Output: response media `application/json`

### `vikunja vikunja_api project put-projects-id-views-view-buckets`

- Summary: Create a new bucket
- HTTP: `PUT /projects/{id}/views/{view}/buckets`
- Auth: required
- Body: required
- Flags:
  - `--id` (path, required): Project Id
  - `--view` (path, required): Project view ID
- Output: response media `application/json`

### `vikunja vikunja_api project put-projects-project-id-duplicate`

- Summary: Duplicate an existing project
- HTTP: `PUT /projects/{projectID}/duplicate`
- Auth: required
- Body: required
- Flags:
  - `--project-id` (path, required): The project ID to duplicate
- Output: response media `application/json`

### `vikunja vikunja_api project put-projects-project-views`

- Summary: Create a project view
- HTTP: `PUT /projects/{project}/views`
- Auth: required
- Body: required
- Flags:
  - `--project` (path, required): Project ID
- Output: response media `application/json`

## service

### `vikunja vikunja_api service get-info`

- Summary: Info
- HTTP: `GET /info`
- Auth: required
- Body: none
- Flags: none
- Output: list path `available_migrators`; response media `application/json`

## sharing

### `vikunja vikunja_api sharing delete-projects-project-id-teams-team-id`

- Summary: Delete a team from a project
- HTTP: `DELETE /projects/{projectID}/teams/{teamID}`
- Auth: required
- Body: none
- Flags:
  - `--project-id` (path, required): Project ID
  - `--team-id` (path, required): Team ID
- Output: response media `application/json`

### `vikunja vikunja_api sharing delete-projects-project-id-users-user-id`

- Summary: Delete a user from a project
- HTTP: `DELETE /projects/{projectID}/users/{userID}`
- Auth: required
- Body: none
- Flags:
  - `--project-id` (path, required): Project ID
  - `--user-id` (path, required): User ID
- Output: response media `application/json`

### `vikunja vikunja_api sharing delete-projects-project-shares-share`

- Summary: Remove a link share
- HTTP: `DELETE /projects/{project}/shares/{share}`
- Auth: required
- Body: none
- Flags:
  - `--project` (path, required): Project ID
  - `--share` (path, required): Share Link ID
- Output: response media `application/json`

### `vikunja vikunja_api sharing get-projects-id-teams`

- Summary: Get teams on a project
- HTTP: `GET /projects/{id}/teams`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): Project ID
  - `--page` (query): The page number. Used for pagination. If not provided, the first page of results is returned.
  - `--per_page` (query): The maximum number of items per page. Note this parameter is limited by the configured maximum of items per page.
  - `--s` (query): Search teams by its name.
- Output: columns `name`, `id`, `created`, `created_by`, `description`, `external_id`; response media `application/json`; pagination `offset`

### `vikunja vikunja_api sharing get-projects-id-users`

- Summary: Get users on a project
- HTTP: `GET /projects/{id}/users`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): Project ID
  - `--page` (query): The page number. Used for pagination. If not provided, the first page of results is returned.
  - `--per_page` (query): The maximum number of items per page. Note this parameter is limited by the configured maximum of items per page.
  - `--s` (query): Search users by its name.
- Output: columns `name`, `id`, `bot_owner_id`, `created`, `email`, `permission`; response media `application/json`; pagination `offset`

### `vikunja vikunja_api sharing get-projects-project-shares`

- Summary: Get all link shares for a project
- HTTP: `GET /projects/{project}/shares`
- Auth: required
- Body: none
- Flags:
  - `--project` (path, required): Project ID
  - `--page` (query): The page number. Used for pagination. If not provided, the first page of results is returned.
  - `--per_page` (query): The maximum number of items per page. Note this parameter is limited by the configured maximum of items per page.
  - `--s` (query): Search shares by hash.
- Output: columns `name`, `id`, `created`, `hash`, `password`, `permission`; response media `application/json`; pagination `offset`

### `vikunja vikunja_api sharing get-projects-project-shares-share`

- Summary: Get one link shares for a project
- HTTP: `GET /projects/{project}/shares/{share}`
- Auth: required
- Body: none
- Flags:
  - `--project` (path, required): Project ID
  - `--share` (path, required): Share ID
- Output: response media `application/json`

### `vikunja vikunja_api sharing post-notifications`

- Summary: Mark all notifications of a user as read
- HTTP: `POST /notifications`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

### `vikunja vikunja_api sharing post-projects-project-id-teams-team-id`

- Summary: Update a team <-> project relation
- HTTP: `POST /projects/{projectID}/teams/{teamID}`
- Auth: required
- Body: required
- Flags:
  - `--project-id` (path, required): Project ID
  - `--team-id` (path, required): Team ID
- Output: response media `application/json`

### `vikunja vikunja_api sharing post-projects-project-id-users-user-id`

- Summary: Update a user <-> project relation
- HTTP: `POST /projects/{projectID}/users/{userID}`
- Auth: required
- Body: required
- Flags:
  - `--project-id` (path, required): Project ID
  - `--user-id` (path, required): User ID
- Output: response media `application/json`

### `vikunja vikunja_api sharing post-shares-share-auth`

- Summary: Get an auth token for a share
- HTTP: `POST /shares/{share}/auth`
- Auth: required
- Body: required
- Flags:
  - `--share` (path, required): The share hash
- Output: response media `application/json`

### `vikunja vikunja_api sharing put-projects-id-teams`

- Summary: Add a team to a project
- HTTP: `PUT /projects/{id}/teams`
- Auth: required
- Body: required
- Flags:
  - `--id` (path, required): Project ID
- Output: response media `application/json`

### `vikunja vikunja_api sharing put-projects-id-users`

- Summary: Add a user to a project
- HTTP: `PUT /projects/{id}/users`
- Auth: required
- Body: required
- Flags:
  - `--id` (path, required): Project ID
- Output: response media `application/json`

### `vikunja vikunja_api sharing put-projects-project-shares`

- Summary: Share a project via link
- HTTP: `PUT /projects/{project}/shares`
- Auth: required
- Body: required
- Flags:
  - `--project` (path, required): Project ID
- Output: response media `application/json`

## subscriptions

### `vikunja vikunja_api subscriptions delete-subscriptions-entity-entity-id`

- Summary: Unsubscribe the current user from an entity.
- HTTP: `DELETE /subscriptions/{entity}/{entityID}`
- Auth: required
- Body: none
- Flags:
  - `--entity` (path, required): The entity the user subscribed to. Can be either `project` or `task`.
  - `--entity-id` (path, required): The numeric id of the subscribed entity to.
- Output: response media `application/json`

### `vikunja vikunja_api subscriptions get-notifications`

- Summary: Get all notifications for the current user
- HTTP: `GET /notifications`
- Auth: required
- Body: none
- Flags:
  - `--page` (query): The page number. Used for pagination. If not provided, the first page of results is returned.
  - `--per_page` (query): The maximum number of items per page. Note this parameter is limited by the configured maximum of items per page.
- Output: columns `name`, `id`, `created`, `notification`, `read_at`; response media `application/json`; pagination `offset`

### `vikunja vikunja_api subscriptions post-notifications-id`

- Summary: Mark a notification as (un-)read
- HTTP: `POST /notifications/{id}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): Notification ID
- Output: response media `application/json`

### `vikunja vikunja_api subscriptions put-subscriptions-entity-entity-id`

- Summary: Subscribes the current user to an entity.
- HTTP: `PUT /subscriptions/{entity}/{entityID}`
- Auth: required
- Body: none
- Flags:
  - `--entity` (path, required): The entity the user subscribes to. Can be either `project` or `task`.
  - `--entity-id` (path, required): The numeric id of the entity to subscribe to.
- Output: response media `application/json`

## task

### `vikunja vikunja_api task delete-tasks-id`

- Summary: Delete a task
- HTTP: `DELETE /tasks/{id}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): Task ID
- Output: response media `application/json`

### `vikunja vikunja_api task delete-tasks-id-attachments-attachment-id`

- Summary: Delete an attachment
- HTTP: `DELETE /tasks/{id}/attachments/{attachmentID}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): Task ID
  - `--attachment-id` (path, required): Attachment ID
- Output: response media `application/json`

### `vikunja vikunja_api task delete-tasks-task-id-comments-comment-id`

- Summary: Remove a task comment
- HTTP: `DELETE /tasks/{taskID}/comments/{commentID}`
- Auth: required
- Body: none
- Flags:
  - `--task-id` (path, required): Task ID
  - `--comment-id` (path, required): Comment ID
- Output: response media `application/json`

### `vikunja vikunja_api task delete-tasks-task-id-relations-relation-kind-other-task-id`

- Summary: Remove a task relation
- HTTP: `DELETE /tasks/{taskID}/relations/{relationKind}/{otherTaskID}`
- Auth: required
- Body: required
- Flags:
  - `--task-id` (path, required): Task ID
  - `--relation-kind` (path, required): The kind of the relation. See the TaskRelation type for more info.
  - `--other-task-id` (path, required): The id of the other task.
- Output: response media `application/json`

### `vikunja vikunja_api task get-kind-id-reactions`

- Summary: Get all reactions for an entity
- HTTP: `GET /{kind}/{id}/reactions`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): Entity ID
  - `--kind` (path, required): The kind of the entity. Can be either `tasks` or `comments` for task comments
- Output: response media `application/json`

### `vikunja vikunja_api task get-projects-id-views-view-tasks`

- Summary: Get tasks in a project
- HTTP: `GET /projects/{id}/views/{view}/tasks`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): The project ID.
  - `--view` (path, required): The project view ID.
  - `--page` (query): The page number. Used for pagination. If not provided, the first page of results is returned.
  - `--per_page` (query): The maximum number of items per page. Note this parameter is limited by the configured maximum of items per page.
  - `--s` (query): Search tasks by task text.
  - `--sort_by` (query): The sorting parameter. You can pass this multiple times to get the tasks ordered by multiple different parametes, along with `order_by`. Possible values to sort by are `id`, `title`, `description`, `done`, `done_at`, `due_date`, `created_by_id`, `project_id`, `repeat_after`, `priority`, `start_date`, `end_date`, `hex_color`, `percent_done`, `uid`, `created`, `updated`, `relevance`. `relevance` sorts by search relevance (most relevant first, requires `s`; ignored when the database cannot score the query). Default is `id`.
  - `--order_by` (query): The ordering parameter. Possible values to order by are `asc` or `desc`. Default is `asc`.
  - `--filter` (query): The filter query to match tasks by. Check out https://vikunja.io/docs/filters for a full explanation of the feature.
  - `--filter_timezone` (query): The time zone which should be used for date match (statements like
  - `--filter_include_nulls` (query): If set to true the result will include filtered fields whose value is set to `null`. Available values are `true` or `false`. Defaults to `false`.
  - `--expand` (query): If set to `subtasks`, Vikunja will fetch only tasks which do not have subtasks and then in a second step, will fetch all of these subtasks. This may result in more tasks than the pagination limit being returned, but all subtasks will be present in the response. If set to `buckets`, the buckets of each task will be present in the response. If set to `reactions`, the reactions of each task will be present in the response. If set to `comments`, the first 50 comments of each task will be present in the response. You can set this multiple times with different values.
- Output: columns `id`, `bucket_id`, `comment_count`, `cover_image_attachment_id`, `created`, `created_by`; response media `application/json`; pagination `offset`

### `vikunja vikunja_api task get-projects-project-tasks-by-index-index`

- Summary: Get one task by its per-project index
- HTTP: `GET /projects/{project}/tasks/by-index/{index}`
- Auth: required
- Body: none
- Flags:
  - `--project` (path, required): The project id or the project's identifier
  - `--index` (path, required): The task's per-project index
  - `--expand` (query): If set to `subtasks`, Vikunja will fetch only tasks which do not have subtasks and then in a second step, will fetch all of these subtasks. This may result in more tasks than the pagination limit being returned, but all subtasks will be present in the response. You can only set this to `subtasks`.
- Output: list path `assignees`; columns `name`, `id`, `bot_owner_id`, `created`, `email`, `updated`; response media `application/json`

### `vikunja vikunja_api task get-tasks`

- Summary: Get tasks
- HTTP: `GET /tasks`
- Auth: required
- Body: none
- Flags:
  - `--page` (query): The page number. Used for pagination. If not provided, the first page of results is returned.
  - `--per_page` (query): The maximum number of items per page. Note this parameter is limited by the configured maximum of items per page.
  - `--s` (query): Search tasks by task text.
  - `--sort_by` (query): The sorting parameter. You can pass this multiple times to get the tasks ordered by multiple different parametes, along with `order_by`. Possible values to sort by are `id`, `title`, `description`, `done`, `done_at`, `due_date`, `created_by_id`, `project_id`, `repeat_after`, `priority`, `start_date`, `end_date`, `hex_color`, `percent_done`, `uid`, `created`, `updated`, `relevance`. `relevance` sorts by search relevance (most relevant first, requires `s`; ignored when the database cannot score the query). Default is `id`.
  - `--order_by` (query): The ordering parameter. Possible values to order by are `asc` or `desc`. Default is `asc`.
  - `--filter` (query): The filter query to match tasks by. Check out https://vikunja.io/docs/filters for a full explanation of the feature.
  - `--filter_timezone` (query): The time zone which should be used for date match (statements like
  - `--filter_include_nulls` (query): If set to true the result will include filtered fields whose value is set to `null`. Available values are `true` or `false`. Defaults to `false`.
  - `--expand` (query): If set to `subtasks`, Vikunja will fetch only tasks which do not have subtasks and then in a second step, will fetch all of these subtasks. This may result in more tasks than the pagination limit being returned, but all subtasks will be present in the response. If set to `buckets`, the buckets of each task will be present in the response. If set to `reactions`, the reactions of each task will be present in the response. If set to `comments`, the first 50 comments of each task will be present in the response. You can set this multiple times with different values.
- Output: columns `id`, `bucket_id`, `comment_count`, `cover_image_attachment_id`, `created`, `created_by`; response media `application/json`; pagination `offset`

### `vikunja vikunja_api task get-tasks-id`

- Summary: Get one task
- HTTP: `GET /tasks/{id}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): The task ID
  - `--expand` (query): If set to `subtasks`, Vikunja will fetch only tasks which do not have subtasks and then in a second step, will fetch all of these subtasks. This may result in more tasks than the pagination limit being returned, but all subtasks will be present in the response. If set to `buckets`, the buckets of each task will be present in the response. If set to `reactions`, the reactions of each task will be present in the response. If set to `comments`, the first 50 comments of each task will be present in the response. You can set this multiple times with different values.
- Output: list path `assignees`; columns `name`, `id`, `bot_owner_id`, `created`, `email`, `updated`; response media `application/json`

### `vikunja vikunja_api task get-tasks-id-attachments`

- Summary: Get all attachments for one task.
- HTTP: `GET /tasks/{id}/attachments`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): Task ID
  - `--page` (query): The page number. Used for pagination. If not provided, the first page of results is returned.
  - `--per_page` (query): The maximum number of items per page. Note this parameter is limited by the configured maximum of items per page.
- Output: columns `id`, `created`, `task_id`; response media `application/json`; pagination `offset`

### `vikunja vikunja_api task get-tasks-id-attachments-attachment-id`

- Summary: Get one attachment.
- HTTP: `GET /tasks/{id}/attachments/{attachmentID}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): Task ID
  - `--attachment-id` (path, required): Attachment ID
  - `--preview_size` (query): The size of the preview image. Can be sm = 100px, md = 200px, lg = 400px or xl = 800px. If provided, a preview image will be returned if the attachment is an image.
- Output: response media `application/octet-stream`

### `vikunja vikunja_api task get-tasks-task-id-comments`

- Summary: Get all task comments
- HTTP: `GET /tasks/{taskID}/comments`
- Auth: required
- Body: none
- Flags:
  - `--task-id` (path, required): Task ID
  - `--order_by` (query): Sort order. Can be 'asc' for ascending or 'desc' for descending. Defaults to 'asc'.
- Output: columns `id`, `comment`, `created`, `updated`; response media `application/json`

### `vikunja vikunja_api task get-tasks-task-id-comments-comment-id`

- Summary: Get a task comment
- HTTP: `GET /tasks/{taskID}/comments/{commentID}`
- Auth: required
- Body: none
- Flags:
  - `--task-id` (path, required): Task ID
  - `--comment-id` (path, required): Comment ID
- Output: response media `application/json`

### `vikunja vikunja_api task post-kind-id-reactions-delete`

- Summary: Removes the user's reaction
- HTTP: `POST /{kind}/{id}/reactions/delete`
- Auth: required
- Body: required
- Flags:
  - `--id` (path, required): Entity ID
  - `--kind` (path, required): The kind of the entity. Can be either `tasks` or `comments` for task comments
- Output: response media `application/json`

### `vikunja vikunja_api task post-projects-project-views-view-buckets-bucket-tasks`

- Summary: Update a task bucket
- HTTP: `POST /projects/{project}/views/{view}/buckets/{bucket}/tasks`
- Auth: required
- Body: required
- Flags:
  - `--project` (path, required): Project ID
  - `--view` (path, required): Project View ID
  - `--bucket` (path, required): Bucket ID
- Output: response media `application/json`

### `vikunja vikunja_api task post-tasks-bulk`

- Summary: Update multiple tasks
- HTTP: `POST /tasks/bulk`
- Auth: required
- Body: required
- Flags: none
- Output: columns `id`, `bucket_id`, `comment_count`, `cover_image_attachment_id`, `created`, `created_by`; response media `application/json`

### `vikunja vikunja_api task post-tasks-id`

- Summary: Update a task
- HTTP: `POST /tasks/{id}`
- Auth: required
- Body: required
- Flags:
  - `--id` (path, required): The Task ID
- Output: list path `assignees`; columns `name`, `id`, `bot_owner_id`, `created`, `email`, `updated`; response media `application/json`

### `vikunja vikunja_api task post-tasks-id-position`

- Summary: Updates a task position
- HTTP: `POST /tasks/{id}/position`
- Auth: required
- Body: required
- Flags:
  - `--id` (path, required): Task ID
- Output: response media `application/json`

### `vikunja vikunja_api task post-tasks-projecttask-read`

- Summary: Mark a task as read
- HTTP: `POST /tasks/{projecttask}/read`
- Auth: required
- Body: none
- Flags:
  - `--projecttask` (path, required): Task ID
- Output: response media `application/json`

### `vikunja vikunja_api task post-tasks-task-id-comments-comment-id`

- Summary: Update an existing task comment
- HTTP: `POST /tasks/{taskID}/comments/{commentID}`
- Auth: required
- Body: none
- Flags:
  - `--task-id` (path, required): Task ID
  - `--comment-id` (path, required): Comment ID
- Output: response media `application/json`

### `vikunja vikunja_api task put-kind-id-reactions`

- Summary: Add a reaction to an entity
- HTTP: `PUT /{kind}/{id}/reactions`
- Auth: required
- Body: required
- Flags:
  - `--id` (path, required): Entity ID
  - `--kind` (path, required): The kind of the entity. Can be either `tasks` or `comments` for task comments
- Output: response media `application/json`

### `vikunja vikunja_api task put-projects-id-tasks`

- Summary: Create a task
- HTTP: `PUT /projects/{id}/tasks`
- Auth: required
- Body: required
- Flags:
  - `--id` (path, required): Project ID
- Output: response media `application/json`

### `vikunja vikunja_api task put-tasks-id-attachments`

- Summary: Upload a task attachment
- HTTP: `PUT /tasks/{id}/attachments`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): Task ID
  - `--files` (formData, required): The file, as multipart form file. You can pass multiple.
- Output: response media `application/json`

### `vikunja vikunja_api task put-tasks-task-id-comments`

- Summary: Create a new task comment
- HTTP: `PUT /tasks/{taskID}/comments`
- Auth: required
- Body: required
- Flags:
  - `--task-id` (path, required): Task ID
- Output: response media `application/json`

### `vikunja vikunja_api task put-tasks-task-id-duplicate`

- Summary: Duplicate a task
- HTTP: `PUT /tasks/{taskID}/duplicate`
- Auth: required
- Body: none
- Flags:
  - `--task-id` (path, required): The task ID to duplicate
- Output: response media `application/json`

### `vikunja vikunja_api task put-tasks-task-id-relations`

- Summary: Create a new relation between two tasks
- HTTP: `PUT /tasks/{taskID}/relations`
- Auth: required
- Body: required
- Flags:
  - `--task-id` (path, required): Task ID
- Output: response media `application/json`

## team

### `vikunja vikunja_api team delete-teams-id`

- Summary: Deletes a team
- HTTP: `DELETE /teams/{id}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): Team ID
- Output: response media `application/json`

### `vikunja vikunja_api team delete-teams-id-members-username`

- Summary: Remove a user from a team
- HTTP: `DELETE /teams/{id}/members/{username}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): The ID of the team you want to remove th user from
  - `--username` (path, required): The username of the user you want to remove
- Output: response media `application/json`

### `vikunja vikunja_api team get-teams`

- Summary: Get teams
- HTTP: `GET /teams`
- Auth: required
- Body: none
- Flags:
  - `--page` (query): The page number. Used for pagination. If not provided, the first page of results is returned.
  - `--per_page` (query): The maximum number of items per page. Note this parameter is limited by the configured maximum of items per page.
  - `--s` (query): Search teams by its name.
- Output: columns `name`, `id`, `created`, `created_by`, `description`, `external_id`; response media `application/json`; pagination `offset`

### `vikunja vikunja_api team get-teams-id`

- Summary: Gets one team
- HTTP: `GET /teams/{id}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): Team ID
- Output: list path `members`; columns `name`, `id`, `admin`, `bot_owner_id`, `created`, `email`; response media `application/json`

### `vikunja vikunja_api team post-teams-id`

- Summary: Updates a team
- HTTP: `POST /teams/{id}`
- Auth: required
- Body: required
- Flags:
  - `--id` (path, required): Team ID
- Output: list path `members`; columns `name`, `id`, `admin`, `bot_owner_id`, `created`, `email`; response media `application/json`

### `vikunja vikunja_api team post-teams-id-members-user-id-admin`

- Summary: Toggle a team member's admin status
- HTTP: `POST /teams/{id}/members/{userID}/admin`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): Team ID
  - `--user-id` (path, required): User ID
- Output: response media `application/json`

### `vikunja vikunja_api team put-teams`

- Summary: Creates a new team
- HTTP: `PUT /teams`
- Auth: required
- Body: required
- Flags: none
- Output: response media `application/json`

### `vikunja vikunja_api team put-teams-id-members`

- Summary: Add a user to a team
- HTTP: `PUT /teams/{id}/members`
- Auth: required
- Body: required
- Flags:
  - `--id` (path, required): Team ID
- Output: response media `application/json`

## testing

### `vikunja vikunja_api testing delete-test-all`

- Summary: Truncate all tables
- HTTP: `DELETE /test/all`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

### `vikunja vikunja_api testing patch-test-table`

- Summary: Reset the db to a defined state
- HTTP: `PATCH /test/{table}`
- Auth: required
- Body: none
- Flags:
  - `--table` (path, required): The table to reset
- Output: response media `application/json`

## user

### `vikunja vikunja_api user delete-user-settings-token-caldav-id`

- Summary: Delete a caldav token by id
- HTTP: `DELETE /user/settings/token/caldav/{id}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): Token ID
- Output: response media `application/json`

### `vikunja vikunja_api user get-user`

- Summary: Get user information
- HTTP: `GET /user`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

### `vikunja vikunja_api user get-user-export`

- Summary: Get current user data export
- HTTP: `GET /user/export`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

### `vikunja vikunja_api user get-user-settings-avatar`

- Summary: Return user avatar setting
- HTTP: `GET /user/settings/avatar`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

### `vikunja vikunja_api user get-user-settings-token-caldav`

- Summary: Returns the caldav tokens for the current user
- HTTP: `GET /user/settings/token/caldav`
- Auth: required
- Body: none
- Flags: none
- Output: columns `id`, `created`, `token`; response media `application/json`

### `vikunja vikunja_api user get-user-settings-totp`

- Summary: Totp setting for the current user
- HTTP: `GET /user/settings/totp`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

### `vikunja vikunja_api user get-user-settings-totp-qrcode`

- Summary: Totp QR Code
- HTTP: `GET /user/settings/totp/qrcode`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

### `vikunja vikunja_api user get-user-timezones`

- Summary: Get all available time zones on this vikunja instance
- HTTP: `GET /user/timezones`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

### `vikunja vikunja_api user get-username-avatar`

- Summary: User Avatar
- HTTP: `GET /{username}/avatar`
- Auth: required
- Body: none
- Flags:
  - `--username` (path, required): The username of the user who's avatar you want to get
  - `--size` (query): The size of the avatar you want to get. If bigger than the max configured size this will be adjusted to the maximum size.
- Output: response media `application/octet-stream`

### `vikunja vikunja_api user get-users`

- Summary: Get users
- HTTP: `GET /users`
- Auth: required
- Body: none
- Flags:
  - `--s` (query): The search criteria.
- Output: columns `name`, `id`, `bot_owner_id`, `created`, `email`, `updated`; response media `application/json`

### `vikunja vikunja_api user post-user-confirm`

- Summary: Confirm the email of a new user
- HTTP: `POST /user/confirm`
- Auth: required
- Body: required
- Flags: none
- Output: response media `application/json`

### `vikunja vikunja_api user post-user-deletion-cancel`

- Summary: Abort a user deletion request
- HTTP: `POST /user/deletion/cancel`
- Auth: required
- Body: required
- Flags: none
- Output: response media `application/json`

### `vikunja vikunja_api user post-user-deletion-confirm`

- Summary: Confirm a user deletion request
- HTTP: `POST /user/deletion/confirm`
- Auth: required
- Body: required
- Flags: none
- Output: response media `application/json`

### `vikunja vikunja_api user post-user-deletion-request`

- Summary: Request the deletion of the user
- HTTP: `POST /user/deletion/request`
- Auth: required
- Body: required
- Flags: none
- Output: response media `application/json`

### `vikunja vikunja_api user post-user-export-download`

- Summary: Download a user data export.
- HTTP: `POST /user/export/download`
- Auth: required
- Body: required
- Flags: none
- Output: response media `application/json`

### `vikunja vikunja_api user post-user-export-request`

- Summary: Request a user data export.
- HTTP: `POST /user/export/request`
- Auth: required
- Body: required
- Flags: none
- Output: response media `application/json`

### `vikunja vikunja_api user post-user-password`

- Summary: Change password
- HTTP: `POST /user/password`
- Auth: required
- Body: required
- Flags: none
- Output: response media `application/json`

### `vikunja vikunja_api user post-user-password-reset`

- Summary: Resets a password
- HTTP: `POST /user/password/reset`
- Auth: required
- Body: required
- Flags: none
- Output: response media `application/json`

### `vikunja vikunja_api user post-user-password-token`

- Summary: Request password reset token
- HTTP: `POST /user/password/token`
- Auth: required
- Body: required
- Flags: none
- Output: response media `application/json`

### `vikunja vikunja_api user post-user-settings-avatar`

- Summary: Set the user's avatar
- HTTP: `POST /user/settings/avatar`
- Auth: required
- Body: required
- Flags: none
- Output: response media `application/json`

### `vikunja vikunja_api user post-user-settings-email`

- Summary: Update email address
- HTTP: `POST /user/settings/email`
- Auth: required
- Body: required
- Flags: none
- Output: response media `application/json`

### `vikunja vikunja_api user post-user-settings-general`

- Summary: Change general user settings of the current user.
- HTTP: `POST /user/settings/general`
- Auth: required
- Body: required
- Flags: none
- Output: response media `application/json`

### `vikunja vikunja_api user post-user-settings-totp-disable`

- Summary: Disable totp settings
- HTTP: `POST /user/settings/totp/disable`
- Auth: required
- Body: required
- Flags: none
- Output: response media `application/json`

### `vikunja vikunja_api user post-user-settings-totp-enable`

- Summary: Enable a previously enrolled totp setting.
- HTTP: `POST /user/settings/totp/enable`
- Auth: required
- Body: required
- Flags: none
- Output: response media `application/json`

### `vikunja vikunja_api user post-user-settings-totp-enroll`

- Summary: Enroll a user into totp
- HTTP: `POST /user/settings/totp/enroll`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

### `vikunja vikunja_api user put-user-settings-avatar-upload`

- Summary: Upload a user avatar
- HTTP: `PUT /user/settings/avatar/upload`
- Auth: required
- Body: none
- Flags:
  - `--avatar` (formData, required): The avatar as single file.
- Output: response media `application/json`

### `vikunja vikunja_api user put-user-settings-token-caldav`

- Summary: Generate a caldav token
- HTTP: `PUT /user/settings/token/caldav`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

## webhooks

### `vikunja vikunja_api webhooks delete-projects-id-webhooks-webhook-id`

- Summary: Deletes an existing webhook target
- HTTP: `DELETE /projects/{id}/webhooks/{webhookID}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): Project ID
  - `--webhook-id` (path, required): Webhook ID
- Output: response media `application/json`

### `vikunja vikunja_api webhooks delete-user-settings-webhooks-id`

- Summary: Delete a user-level webhook target
- HTTP: `DELETE /user/settings/webhooks/{id}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): Webhook ID
- Output: response media `application/json`

### `vikunja vikunja_api webhooks get-projects-id-webhooks`

- Summary: Get all api webhook targets for the specified project
- HTTP: `GET /projects/{id}/webhooks`
- Auth: required
- Body: none
- Flags:
  - `--page` (query): The page number. Used for pagination. If not provided, the first page of results is returned.
  - `--per_page` (query): The maximum number of items per bucket per page. This parameter is limited by the configured maximum of items per page.
  - `--id` (path, required): Project ID
- Output: columns `id`, `basic_auth_password`, `basic_auth_user`, `created`, `created_by`, `project_id`; response media `application/json`; pagination `offset`

### `vikunja vikunja_api webhooks get-user-settings-webhooks`

- Summary: Get all user-level webhook targets
- HTTP: `GET /user/settings/webhooks`
- Auth: required
- Body: none
- Flags: none
- Output: columns `id`, `basic_auth_password`, `basic_auth_user`, `created`, `created_by`, `project_id`; response media `application/json`

### `vikunja vikunja_api webhooks get-user-settings-webhooks-events`

- Summary: Get available user-directed webhook events
- HTTP: `GET /user/settings/webhooks/events`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

### `vikunja vikunja_api webhooks get-webhooks-events`

- Summary: Get all possible webhook events
- HTTP: `GET /webhooks/events`
- Auth: required
- Body: none
- Flags: none
- Output: response media `application/json`

### `vikunja vikunja_api webhooks post-projects-id-webhooks-webhook-id`

- Summary: Change a webhook target's events.
- HTTP: `POST /projects/{id}/webhooks/{webhookID}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): Project ID
  - `--webhook-id` (path, required): Webhook ID
- Output: list path `events`; response media `application/json`

### `vikunja vikunja_api webhooks post-user-settings-webhooks-id`

- Summary: Update a user-level webhook target
- HTTP: `POST /user/settings/webhooks/{id}`
- Auth: required
- Body: none
- Flags:
  - `--id` (path, required): Webhook ID
- Output: list path `events`; response media `application/json`

### `vikunja vikunja_api webhooks put-projects-id-webhooks`

- Summary: Create a webhook target
- HTTP: `PUT /projects/{id}/webhooks`
- Auth: required
- Body: required
- Flags:
  - `--id` (path, required): Project ID
- Output: response media `application/json`

### `vikunja vikunja_api webhooks put-user-settings-webhooks`

- Summary: Create a user-level webhook target
- HTTP: `PUT /user/settings/webhooks`
- Auth: required
- Body: required
- Flags: none
- Output: list path `events`; response media `application/json`