OpenProject Configuration API
The configuration endpoint allows to read certain configuration parameters of the OpenProject instance.Note that there is no 1:1 relationship between this endpoint and the settings an administrator has at hand to modify the behaviourof the application via configuration.yml or ENV variables.For now this endpoint will only allow access to settings deemed useful for a client to know in general.As clients might rely on the combination of both, the system settings as well as the current user's preferences, the resourceembeds the current user's preferences so client can fetch both with one request.| Link | Description | Type | Nullable | Supported operations ||:-------------------:| ------------------------------------------------ | ------------- | -------- | -------------------- || self | The configuration | Configuration | | READ || userPreferences | The preferences of the current user | UserPreferences | | READ |## Local Properties| Property | Description | Type | Condition | Supported operations || :-----------------------: | -------------------------------------------------------------------------- | ---------- | ----------------- | -------------------- || maximumAttachmentFileSize | The maximum allowed size of an attachment in Bytes | Integer | | READ || perPageOptions | Page size steps to be offered in paginated list UI | Integer[] | | READ || hostName | The host name configured for the system | String | | READ || durationFormat | The format used to display Work, Remaining Work, and Spent time durations. | String | | READ || activeFeatureFlags | The list of all feature flags that are active | String[] | | READ |
OpenProject Configuration API is one of 62 APIs that OpenProject publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Configuration. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.
This API exposes 2 operations across 2 paths, and defines 3 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 Configuration API declares
1 security scheme
for authenticating requests.
It accepts HTTP basic authentication (BasicAuth).
By default, every request must be authenticated.
Paths & Operations 2
Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.
The configuration endpoint allows to read certain configuration parameters of the OpenProject instance. Note that there is no 1:1 relationship between this endpoint and the settin…
Schemas 3
The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are ConfigurationModel (5 properties), ErrorResponse (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 Configuration 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.