OpenProject Root API
The root resource contains links to available resources in the API. By following these linksa client should be able to discover further resources in the API.*Note: Currently there is no list action for projects available.**A client will therefore have to know links to projects and can't (yet) discover them.*| Link | Description | Type | Nullable | Supported operations | Condition || :-------------------: | ------------------------------------------------ | --------------- | -------- | -------------------- | --------- || configuration | The configuration of this OpenProject instance | Configuration | | READ | || user | The user currently logged-in | User | | READ | logged in || userPreferences | The preferences of the logged-in user | UserPreference | | READ | logged in || priorities | List of available priorities | Collection | | READ | **Permission** View work packages in any project || statuses | List of available work package statuses | Collection | | READ | **Permission** View work packages in any project || types | List of available work package types | Collection | | READ | **Permission** View work packages in any project || workPackages | List of all work packages | Collection | | READ | **Permission** View work packages in any project || users | List of all users | Collection | | READ | **Permission** Administrator |## Local Properties| Property | Description | Type | Condition | Supported operations || :-----------------------: | ---------------------------------------------------- | ---------- | --------------------------------- | -------------------- || instanceName | The name of the OpenProject instance | String | | READ || coreVersion | The OpenProject core version number for the instance | String | **Permission** requires admin privileges | READ |
OpenProject Root API is one of 62 APIs that OpenProject publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Root. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 1 operation across 1 path, and defines 2 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 Root API declares
1 security scheme
for authenticating requests.
It accepts HTTP basic authentication (BasicAuth).
By default, every request must be authenticated.
Paths & Operations 1
Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.
The root resource contains links to available resources in the API. By following these links a client should be able to discover further resources in the API. Note: Currently ther…
Schemas 2
The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Link (7 properties), RootModel (4 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 Root 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.