List visible projects with optional name or identifier search.

select restricts each result row to the given fields (e.g. ["id", "name", "identifier"]); an invalid name returns the allowed set. Common fields: id, name, identifier, active, public, status, parent_name, created_at, updated_at.

limit is capped at OPENPROJECT_MAX_PAGE_SIZE (default 50); pass the returned next_offset as the next call's offset to page past the cap. Under a restrictive OPENPROJECT_READ_PROJECTS, total is only the count of allowed projects returned on THIS page, not a full count of all matches — the search stops as soon as it has enough, so an exact total would need an extra full walk. Page until next_offset is null.

Get a compact project summary by id or identifier.

project: numeric id (e.g., 7) or identifier (e.g., "my-project"), not display name.

Return project admin metadata such as lifecycle statuses, parent options, and writable fields.

Return project-scoped configuration such as internal comment support.

List Backlogs sprints visible to the current token.

Requires the OpenProject Backlogs module; unavailable instances return a clear not-found message.

limit is capped at OPENPROJECT_MAX_PAGE_SIZE (default 50); pass the returned next_offset as the next call's offset to page past the cap. total is only the count of allowed sprints returned on THIS page, not a full count of all matches — the search stops as soon as it has enough, so an exact total would need an extra full walk. Page until next_offset is null.

List Backlogs sprints for a project by id or identifier.

limit is capped at OPENPROJECT_MAX_PAGE_SIZE (default 50); pass the returned next_offset as the next call's offset to page past the cap. total is only the count of allowed sprints returned on THIS page, not a full count of all matches — the search stops as soon as it has enough, so an exact total would need an extra full walk. Page until next_offset is null.

Get a Backlogs sprint by id.

List documents, optionally filtered to a single project.

limit is capped at OPENPROJECT_MAX_PAGE_SIZE (default 50); pass the returned next_offset as the next call's offset to page past the cap. total is only the count of allowed documents returned on THIS page, not a full count of all matches — the search stops as soon as it has enough, so an exact total would need an extra full walk. Page until next_offset is null.

Get a single document by id.

List news entries, optionally filtered by project or title/summary search.

limit is capped at OPENPROJECT_MAX_PAGE_SIZE (default 50); pass the returned next_offset as the next call's offset to page past the cap. total is only the count of allowed news entries returned on THIS page, not a full count of all matches — the search stops as soon as it has enough, so an exact total would need an extra full walk. Page until next_offset is null.

Get a single news entry by id.

Get a single wiki page by id.

List saved OpenProject views, optionally filtered by project or view subtype.

limit is capped at OPENPROJECT_MAX_PAGE_SIZE (default 50); pass the returned next_offset as the next call's offset to page past the cap. total is only the count of allowed views returned on THIS page, not a full count of all matches — the search stops as soon as it has enough, so an exact total would need an extra full walk. Page until next_offset is null.

Get a single OpenProject view by id.

List dashboard grids, optionally filtered by scope (page path).

limit is capped at OPENPROJECT_MAX_PAGE_SIZE (default 50); pass the returned next_offset as the next call's offset to page past the cap. total is only the count of allowed grids returned on THIS page, not a full count of all matches — the search stops as soon as it has enough, so an exact total would need an extra full walk. Page until next_offset is null.

Get a single dashboard grid by id.

List work-package categories configured for a project.

Get a single category from a project's category list.

List available project lifecycle phase definitions exposed by OpenProject.

Get a single project lifecycle phase definition by id.

Get a single project lifecycle phase by id.

Return the current user's membership and inferred access hints for a project.

Return project metadata and, optionally, the writable work-package schema for a given type.

Return instance-level OpenProject configuration and active feature flags.

Get the current status of a background job such as project copy.

List work packages with structured filters and no free-text query requirement.

project accepts a numeric ID, exact identifier/slug, or project name; the parameter is named project, not project_id. There is no generic filters=[...] parameter — each filter is its own named argument (version, status, assignee, the date filters, etc.), listed below.

version_status filters by the status of a work package's assigned version: one of 'open', 'closed', or 'locked'.

assignee filters by any user (username, id, or "me"). assignee_me takes precedence.

status/priority filter by exact OpenProject status/priority name or numeric ID (case-insensitive) — not meta-values like 'open'/'closed'; set open_only=true to restrict results to not-closed work packages instead.

Date filters accept YYYY-MM-DD format:

• created_on/updated_on/due_on: exact date match

• created_between/updated_between/due_between: inclusive date range [start, end] Cannot specify both _on and _between for the same field.

sort_by accepts a list of sort criteria in format "field:direction" (e.g., ["status:desc", "priority:asc"]). Direction defaults to "asc" if omitted. Common sortable fields: id, subject, status, priority, type, assignee, author, created_at, updated_at, start_date, due_date.

group_by accepts a field name to group results by (e.g., "status", "assignee"). Common groupable fields: status, priority, type, assignee, author, version, category.

select restricts each result row to the given fields (e.g. ["id", "subject", "status"]); an invalid name returns the allowed set. Common fields: id, display_id, subject, type, status, priority, assignee, project, version, parent_id, parent_display_id, start_date, due_date, estimated_time, spent_time, created_at, updated_at, author, category, description, schedule_manually, derived_start_date, derived_due_date, percentage_done, derived_percentage_done, readonly, ignore_non_working_days. parent_display_id is only populated on OpenProject 17.5+ (semantic mode); it stays null on older/classic instances even when parent_id is set.

limit is capped at OPENPROJECT_MAX_PAGE_SIZE (default 50); pass the returned next_offset as the next call's offset to page past the cap. total is the real matching count only when the query is provably restricted to OPENPROJECT_READ_PROJECTS server-side — scope is unrestricted, an explicit project was given, or (no project, restricted scope) a server-side filter for the resolved allowed project IDs was sent. Otherwise total falls back to this page's item count, and next_offset/truncated are based on whether this page came back full rather than the server's own total, so nothing here ever reveals how many matches exist in projects you can't see. Because of this, total can read 0 while next_offset is still non-null (a restrictive scope filtered out every match on this page, but the raw server page was full) — that is not an inconsistency, keep paging via next_offset rather than stopping on a low/zero total. Page until next_offset is null either way.

Search work packages by free text, optionally scoped to a project.

query matches only the work package subject and numeric ID (OpenProject's native subject_or_id full-text filter) — it does NOT match version, category, description, or other linked-resource fields. To filter by version, use list_work_packages(version=..., project=...) instead.

In parallel with that text/id search, query is always also resolved directly (numeric id or display id like "PROJ-42") the same way get_work_package does. When that resolves to a work package that also satisfies every other filter given here (project/status/assignee/dates/ etc.), it's returned separately as exact_match — never folded into results, and never counted toward total/count/pagination, since a single extra item can't be paginated consistently. Absent (not present in the response at all) when nothing resolves, when the resolved item fails a filter, or when it's already present in results via the text match. select applies to exact_match the same way it applies to each results row.

Without project, the search runs globally across every project readable under OPENPROJECT_READ_PROJECTS, not just one project — pass project explicitly to scope results to it.

Set status to restrict results to an exact OpenProject status name or numeric ID — not a meta-value like 'open'/'closed'. Set open_only=true to return only open (not-closed) work packages. Set assignee_me=true to return only work packages assigned to the current user.

assignee filters by any user (username, id, or "me"). assignee_me takes precedence.

priority filters by priority name or numeric ID (case-insensitive).

Date filters accept YYYY-MM-DD format:

• created_on/updated_on/due_on: exact date match

• created_between/updated_between/due_between: inclusive date range [start, end] Cannot specify both _on and _between for the same field.

sort_by accepts a list of sort criteria in format "field:direction" (e.g., ["status:desc", "priority:asc"]). Direction defaults to "asc" if omitted. Common sortable fields: id, subject, status, priority, type, assignee, author, created_at, updated_at, start_date, due_date.

group_by accepts a field name to group results by (e.g., "status", "assignee"). Common groupable fields: status, priority, type, assignee, author, version, category.

select restricts each result row to the given fields (e.g. ["id", "subject", "status"]); an invalid name returns the allowed set. Common fields: id, display_id, subject, type, status, priority, assignee, project, version, parent_id, parent_display_id, start_date, due_date, estimated_time, spent_time, created_at, updated_at, author, category, description, schedule_manually, derived_start_date, derived_due_date, percentage_done, derived_percentage_done, readonly, ignore_non_working_days. parent_display_id is only populated on OpenProject 17.5+ (semantic mode); it stays null on older/classic instances even when parent_id is set.

limit is capped at OPENPROJECT_MAX_PAGE_SIZE (default 50); pass the returned next_offset as the next call's offset to page past the cap. total is the real matching count only when the query is provably restricted to OPENPROJECT_READ_PROJECTS server-side — scope is unrestricted, or an explicit project was given. Otherwise (no project, restricted scope) total falls back to this page's item count, and next_offset/truncated are based on whether this page came back full rather than the server's own total, so nothing here ever reveals how many matches exist in projects you can't see. Because of this, total can read 0 while next_offset is still non-null (a restrictive scope filtered out every match on this page, but the raw server page was full) — that is not an inconsistency, keep paging via next_offset rather than stopping on a low/zero total. Page until next_offset is null either way.

Get a work package by id, including its full description.

work_package_id: internal id (e.g., 952) or display_id (e.g., "PROJ-51"), not UI display number (e.g., 51) — the same value list_work_packages/ search_work_packages return as each row's id field.

The description is returned in full by default (single work packages are not truncated). Pass text_limit to cap it at that many characters; when the text is cut, description_truncated is true and description_length reports the real length.

Get multiple work packages by ID in a single batch call.

Fetches work packages in parallel and returns per-item results. Failed fetches are reported individually without stopping the batch. Maximum 100 IDs per batch.

ids: internal ids (e.g., 952) or display_ids (e.g., "PROJ-51"), not UI display numbers. Duplicate IDs are automatically deduplicated.

select restricts each result's work_package to the given fields (e.g. ["id", "subject", "status"]); an invalid name returns the allowed set. The id/success/error fields on each result are always included regardless of select, so you can still tell which items succeeded.

For batches with many full-detail items, set text_limit and/or select proactively — an unbounded batch of large work packages can exceed the tool-result size limit and get redirected to a file.

List the current user's open assigned work packages.

limit is capped at OPENPROJECT_MAX_PAGE_SIZE (default 50); pass the returned next_offset as the next call's offset to page past the cap. This query has no project scope of its own, so total is the real matching count only when OPENPROJECT_READ_PROJECTS is unrestricted ("*"); under a restricted scope, total always falls back to this page's item count, and next_offset/truncated are based on whether this page came back full rather than the server's own total, so nothing here ever reveals how many matches exist in projects you can't see. Page until next_offset is null either way.

Get the activity log for a work package, most recent first.

work_package_id: internal id (e.g., 952) or display_id (e.g., "PROJ-51"), not UI display number.

Comments are capped by default to keep the log compact; pass text_limit to widen (or 0-based semantics via a larger value) the per-comment cap. When a comment is cut, comment_truncated is true and comment_length reports its real length.

List emoji reactions across a work package's comment activities.

work_package_id: internal id (e.g., 952) or display_id (e.g., "PROJ-51"), not UI display number.

List the current user's active reminders across all work packages.

Get all relations for a work package (blocks, relates to, duplicates, etc.).

work_package_id: internal id (e.g., 952) or display_id (e.g., "PROJ-51"), not UI display number. type/from_id/to_id reflect how OpenProject actually stored the relation, which does not depend on which work package's relations you query — but can differ from how it was originally requested, since OpenProject canonicalizes some relation types at creation time (e.g. a relation requested as 'precedes' is stored as 'follows' with from_id/to_id swapped; see create_work_package_relation). Use from_id/to_id together with type, not the request you expect to have made, to determine the actual direction. limit is capped at OPENPROJECT_MAX_PAGE_SIZE (default 50); pass the returned next_offset as the next call's offset to page past the cap.

List attachments on a work package.

work_package_id: internal id (e.g., 952) or display_id (e.g., "PROJ-51"), not UI display number.

Get a single attachment by id.

List Nextcloud file links attached to a work package (Community Edition).

work_package_id: internal id (e.g., 952) or display_id (e.g., "PROJ-51"), not UI display number.

List watchers of a work package.

work_package_id: internal id (e.g., 952) or display_id (e.g., "PROJ-51"), not UI display number.

List all available work package statuses.

Read-only: statuses cannot be created or modified via the OpenProject API (Community Edition); configure them in the web admin UI.

Get a single work package status by id.

List all available work package priorities.

Get a single work package priority by id.

List all available work package types, optionally filtered by project.

Read-only: types cannot be created or modified via the OpenProject API (Community Edition); configure them in the web admin UI.

Get a single work package type by id.

List available time entry activities.

List time entries with optional project, work package, user, and date filters.

work_package_id: internal id (e.g., 952) or display_id (e.g., "PROJ-51"), not UI display number.

limit is capped at OPENPROJECT_MAX_PAGE_SIZE (default 50); pass the returned next_offset as the next call's offset to page past the cap. total is only the count of allowed time entries returned on THIS page, not a full count of all matches — the search stops as soon as it has enough, so an exact total would need an extra full walk. Page until next_offset is null.

Get a single time entry by id.

List all relations across the instance, optionally filtered by type (e.g. 'blocks', 'follows').

type/from_id/to_id reflect how OpenProject actually stored the relation (it does not change depending on which work package's relations you're viewing), which can differ from how it was originally requested — OpenProject canonicalizes some relation types at creation time (e.g. a relation requested as 'precedes' is stored as 'follows' with from_id/to_id swapped; see create_work_package_relation). Filtering by relation_type matches the stored (canonical) type, not necessarily the type a caller originally requested when creating it. limit is capped at OPENPROJECT_MAX_PAGE_SIZE (default 50); pass the returned next_offset as the next call's offset to page past the cap.

List memberships for a project, including principal and role names.

Get a compact membership summary by id.

List OpenProject roles visible to the current user.

Return the currently authenticated user's profile.

List API actions exposed by OpenProject.

limit is capped at OPENPROJECT_MAX_PAGE_SIZE (default 50); pass the returned next_offset as the next call's offset to page past the cap.

List API capabilities exposed by OpenProject.

At least one of project or capability_id is required — there is no unfiltered global listing, since one would bypass the project read allowlist.

limit is capped at OPENPROJECT_MAX_PAGE_SIZE (default 50); pass the returned next_offset as the next call's offset to page past the cap.

List versions globally or for a specific project, optionally filtered by a case-insensitive name substring.

limit is capped at OPENPROJECT_MAX_PAGE_SIZE (default 50); pass the returned next_offset as the next call's offset to page past the cap. Without project, total is only the count of allowed versions returned on THIS page, not a full count of all matches — the search stops as soon as it has enough, so an exact total would need an extra full walk. Page until next_offset is null.

Get a compact version summary by id.

List saved OpenProject boards/queries, optionally scoped to a project.

limit is capped at OPENPROJECT_MAX_PAGE_SIZE (default 50); pass the returned next_offset as the next call's offset to page past the cap.

Get a saved OpenProject board/query by id.