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.
OpenProject Versions API is one of 62 APIs that OpenProject publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Versions. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 11 operations across 8 paths, and defines 13 schemas. It is described by OpenAPI 3.1.2, at version 3.
Requests are made against 3 base URLs: https://qa.openproject-edge.com, https://qa.openproject-stage.com, https://community.openproject.org.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
OpenProject Versions API declares
1 security scheme
for authenticating requests.
It accepts HTTP basic authentication (BasicAuth).
By default, every request must be authenticated.
Paths & Operations 11
Across 8 paths, the API surfaces 11 operations — 1 DELETE, 6 GET, 1 PATCH, 3 POST. Each is listed below with its method, path, parameters, and response codes.
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 fin…
Schemas 13
The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are Link (7 properties), CollectionModel (4 properties), ErrorResponse (4 properties), Formattable (3 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from OpenProject 12
Other APIs OpenProject publishes across the network.
This is an independent, third-party profile of OpenProject Versions API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.