List OpenProject projects visible to the API key. Supports OpenProject filter syntax. Common fields: "active" ("=" true/false), "name_and_identifier" ("~" substring), "parent_id" ("=" id).

Get a single project by numeric id or identifier slug.

Create a new project. Requires admin or "add project" permission. Pass either a parent identifier or numeric id via _links.parent.href if creating a sub-project.

Patch an existing project. Only include the fields you want to change.

Delete a project. Destructive; requires admin permission. The deletion is processed asynchronously by OpenProject.

List work packages, optionally scoped to a project. Supports OpenProject filter syntax. Common filter fields: "status_id", "assignee", "project", "type", "priority", "subject" ("~" search), "updatedAt".

Fetch a single work package by numeric id with full HAL detail.

Create a work package in a project. At minimum provide subject, projectId, and typeId. When patching dates use ISO YYYY-MM-DD strings.

Patch fields on a work package. You MUST pass the current lockVersion (fetch it first with op_get_work_package) or OpenProject will reject the update with a stale-object error.

Permanently delete a work package. Destructive.

List activities (comments and changes) on a work package, oldest first.

Add a markdown comment to a work package activity stream. Optionally attach a file and embed it inline using attachFilePath.

Return the user associated with the configured API key.

List users visible to the current API key. Supports filters such as "name" ("~" search), "status" ("=" "active"/"locked"/"invited"), "login" ("=" exact).

Fetch a user by numeric id.

List work package types (Task, Bug, Feature, Milestone, etc.). Optionally scope to a project.

List all work package statuses defined on the instance.

List all priorities defined on the instance.

List versions, optionally filtered to a project.

Escape hatch: call any GET endpoint under /api/v3 directly. Path should start with "/" (e.g. "/queries/42"). Use sparingly — prefer the typed tools above.

List relations for a work package. Relation types: relates, duplicates, duplicated, blocks, blocked, precedes, follows, includes, partOf, requires, required.

Fetch a single relation by id.

Create a relation between two work packages. Types: relates, duplicates, blocks, precedes, follows, includes, partOf, requires.

Delete a relation between work packages.

List attachments on a work package.

Fetch attachment metadata by id. Set saveTo to download the file content to a local path and also return embedLocations showing where the file is referenced in the work package (description and comments).

Upload a file from the local filesystem as an attachment on a work package. Provide the absolute path to the file. Optionally override the file name. Set embedIn to "comment" or "description" to also insert an image reference () into the work package.

Delete an attachment. Destructive.

List in-app notifications for the current user. Common filters: "readIAN" ("=" "t"/"f"), "reason" ("=" "assigned"/"mentioned"/"watched").

Fetch a single notification by id.

Mark a single notification as read.

Mark all notifications as read for the current user.

List users watching a work package.

Add a user as a watcher to a work package.

Remove a user from watching a work package.

List boards (Kanban-style) for a project. Boards are stored as grids scoped to /projects/{id}/boards.

Fetch a single board (grid) by id, including its widget/column configuration.