# OpenProject Versions API

**Canonical:** https://apis.io/apis/openproject/openproject-versions-api/  
**Provider:** OpenProject — https://apis.io/providers/openproject/  
**Base URL:** https://community.openproject.org/api/v3  
**Documentation:** https://www.openproject.org/docs/api/

OpenProject Versions API is one of 62 APIs that [OpenProject](https://apis.io/providers/openproject/) publishes on the [APIs.io](https://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.

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.

## Machine-readable artifacts (5)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/openproject/refs/heads/main/openapi/openproject-versions-api-openapi.yml
- **Documentation** — https://www.openproject.org/docs/api/
- **Introduction** — https://www.openproject.org/docs/api/introduction/
- **Endpoints** — https://www.openproject.org/docs/api/endpoints/
- **GitHub** — https://github.com/opf/openproject

## Other OpenProject APIs (12)

- [OpenProject Actions & Capabilities API](https://apis.io/apis/openproject/openproject-actions-capabilities-api/)
- [OpenProject Activities API](https://apis.io/apis/openproject/openproject-activities-api/)
- [OpenProject Attachments API](https://apis.io/apis/openproject/openproject-attachments-api/)
- [OpenProject Budgets API](https://apis.io/apis/openproject/openproject-budgets-api/)
- [OpenProject Categories API](https://apis.io/apis/openproject/openproject-categories-api/)
- [OpenProject Collections API](https://apis.io/apis/openproject/openproject-collections-api/)
- [OpenProject Configuration API](https://apis.io/apis/openproject/openproject-configuration-api/)
- [OpenProject Custom actions API](https://apis.io/apis/openproject/openproject-custom-actions-api/)
- [OpenProject Custom Field Items API](https://apis.io/apis/openproject/openproject-custom-field-items-api/)
- [OpenProject Custom Fields API](https://apis.io/apis/openproject/openproject-custom-fields-api/)
- [OpenProject Custom Options API](https://apis.io/apis/openproject/openproject-custom-options-api/)
- [OpenProject Documents API](https://apis.io/apis/openproject/openproject-documents-api/)

## Tags

Versions

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/openproject/openproject-versions-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/openproject/.