OpenProject

OpenProject Versions API

Work Packages can be assigned to a version. As such, versions serve to group Work Packages into logical units where each group comprises all the work packages that needs to be finished in order for the version to be finished. ## Actions | Link | Description | Condition | |:-------------------:|--------------------------------------------------------------------------| ---------------------------------------| | update | Form endpoint that aids in preparing and performing edits on the version | **Permission**: manage versions | | updateImmediately | Directly perform edits on the version | **Permission**: manage versions | ## Linked Properties | Link | Description | Type | Constraints | Supported operations | |:-------------------:|----------------------------------------- | ------------- | -------------------------------------------------------------- | -------------------- | | self | This version | Version | not null | READ | | definingProject | The workspace to which the version belongs | Workspace | only present if the workspace is visible for the current user | READ | | availableInProjects | Workspaces where this version can be used | Workspaces | not null | READ | Depending on custom fields defined for versions, additional linked properties might exist. ## Local Properties | Property | Description | Type | Constraints | Supported operations | | :---------: | --------------------------------------------- | ----------- | ----------- | -------------------- | | id | Version id | Integer | x > 0 | READ | | name | Version name | String | not null, may not exceed 60 characters | READ / WRITE | | description | | Formattable | | READ / WRITE | | startDate | | Date | | READ / WRITE | | endDate | | Date | | READ / WRITE | | status | The current status of the version | String | not null, only 'open', 'finished', 'closed' | READ / WRITE | | sharing | The current status of the version | String | not null, limited to fixed set as defined by form | READ / WRITE | | createdAt | Time of creation | DateTime | not null | READ | | updatedAt | Time of the most recent change to the version | DateTime | not null | READ | Depending on custom fields defined for versions, additional properties might exist.

GitHub OpenAPI

Operations 11

GET /api/v3/projects/{id}/versions List versions available in a project #
GET /api/v3/versions List versions #
POST /api/v3/versions Create version #
GET /api/v3/versions/available_projects Available projects for versions #
POST /api/v3/versions/form Version create form #
GET /api/v3/versions/schema View version schema #
GET /api/v3/versions/{id} Get version #
DELETE /api/v3/versions/{id} Delete version #
PATCH /api/v3/versions/{id} Update Version #
POST /api/v3/versions/{id}/form Version update form #
GET /api/v3/workspaces/{id}/versions List versions available in a workspace #

Documentation

📖
Documentation
https://www.openproject.org/docs/api/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/openproject/refs/heads/main/openapi/openproject-versions-api-openapi.yml

Other Resources

🔗
Introduction
https://www.openproject.org/docs/api/introduction/
🔗
Endpoints
https://www.openproject.org/docs/api/endpoints/
🔗
GitHub
https://github.com/opf/openproject

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/openproject-versions-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openproject-versions-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: You're looking at the current **stable** documentation of the OpenProject APIv3.
  title: OpenProject API V3 (Stable) Versions API
  version: '3'
servers:
- url: https://qa.openproject-edge.com
  description: Edge QA instance
- url: https://qa.openproject-stage.com
  description: Staging instance
- url: https://community.openproject.org
  description: Community instance
security:
- BasicAuth: []
tags:


# --- truncated at 32 KB (48 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/openproject/refs/heads/main/openapi/openproject-versions-api-openapi.yml