OpenProject Workspaces API
Workspaces are containers for resources to be worked on and people with sets of permissions that work on the former. There is no actual workspace resourcein OpenProject. Rather, it is the generic term describing:* [Portfolio](https://www.openproject.org/docs/api/endpoints/portfolios)* [Program](https://www.openproject.org/docs/api/endpoints/programs)* [Project](https://www.openproject.org/docs/api/endpoints/projects)A lot of resources reference the workspaces they are valid in, e.g. [Work package](https://www.openproject.org/docs/api/endpoints/work-packages/#linked-properties) and[Memberships](https://www.openproject.org/docs/api/endpoints/memberships/#linked-properties).Before OP 17.0 only projects existed. At that point, the API v3 was already established. That is the reason why quite a number ofresource have links called "project" or similar when they are in fact contained in a different type of workspace. To not break the API, the name of the link was kept. But those links can contain the other types of workspaces as well. It can thus be possible for a work package to have the following:``` { "_links": { "project": { "href": "/api/v3/portfolios/48", "title: "A portfolio" }, ... }, ... }```Accordingly, to set the workspace a resource is in, sending any workspace link to the link property will be accepted by the API.The concept of workspaces is planned to be extended to include further types.
OpenProject Workspaces API is one of 62 APIs that OpenProject publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Workspaces. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 4 operations across 3 paths, and defines 8 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 Workspaces API declares
1 security scheme
for authenticating requests.
It accepts HTTP basic authentication (BasicAuth).
By default, every request must be authenticated.
Paths & Operations 4
Across 3 paths, the API surfaces 4 operations — 1 DELETE, 2 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Workspaces are containers for resources to be worked on and people with sets of permissions that work on the former. There is no actual workspace resource in OpenProject. Rather,…
Schemas 8
The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Workspaces_schemaModel (15 properties), TypeModel (9 properties), SchemaPropertyModel (9 properties), Link (7 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 Workspaces 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.