OpenProject

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 behaviour of 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 resource embeds 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 |

Documentation GitHub OpenAPI

Operations 2

GET /api/v3/configuration View configuration #

GET /api/v3/projects/{id}/configuration View project configuration #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/openproject-configuration-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  description: You're looking at the current **stable** documentation of the OpenProject APIv3.
  title: OpenProject API V3 (Stable) Configuration API
  version: '3'
servers:
- url: https://qa.openproject-edge.com
  description: Edge QA instance
- url: https://qa.openproject-stage.com
  description: Staging instance
- url: https://community.openproject.org
  description: Community instance
security:
- BasicAuth: []
tags:
- description: The configuration endpoint allows to read certain configuration parameters of the OpenProject instance.
  name: Configuration
paths:
  /api/v3/configuration:
    get:
      responses:
        '200':
          content:
            application/hal+json:
              examples:
                response:
                  value:
                    _type: Configuration
                    _links:
                      self:
                        href: /api/v3/configuration
                      userPreferences:
                        href: /api/v3/my_preferences
                    maximumAttachmentFileSize: 5242880
                    hostName: example.com:8080
                    perPageOptions:
                    - 1
                    - 10
                    - 100
                    durationFormat: hours_only
                    activeFeatureFlags:
                    - aFeatureFlag
                    - anotherFeatureFlag
              schema:
                $ref: '#/components/schemas/ConfigurationModel'
          description: OK
          headers: {}
      tags:
      - Configuration
      description: ''
      operationId: View_configuration
      summary: View configuration
  /api/v3/projects/{id}/configuration:
    get:
      parameters:
      - description: Project id
        example: '1'
        in: path
        name: id
        required: true
        schema:
          type: integer
      responses:
        '200':
          content:
            application/hal+json:
              examples:
                response:
                  value:
                    _type: Configuration
                    _links:
                      self:
                        href: /api/v3/projects/1/configuration
                      userPreferences:
                        href: /api/v3/my_preferences
                    maximumAttachmentFileSize: 5242880
                    perPageOptions:
                    - 20
                    - 100
                    enabledInternalComments: true
              schema:
                $ref: '#/components/schemas/ProjectConfigurationModel'
          description: OK
          headers: {}
        '404':
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                response:
                  value:
                    _type: Error
                    errorIdentifier: urn:openproject-org:api:v3:errors:NotFound
                    message: The requested resource could not be found.
          description: Returned if the project does not exist or the user cannot view it.
          headers: {}
      tags:
      - Configuration
      description: 'Returns the configuration scoped to a specific project, including all global

        configuration properties plus project-specific settings.'
      operationId: View_project_configuration
      summary: View project configuration
components:
  schemas:
    ErrorResponse:
      type: object
      required:
      - _type
      - errorIdentifier
      - message
      properties:
        _embedded:
          type: object
          properties:
            details:
              type: object
              properties:
                attribute:
                  type: string
                  example: project
        _type:
          type: string
          enum:
          - Error
        errorIdentifier:
          type: string
          example: urn:openproject-org:api:v3:errors:PropertyConstraintViolation
        message:
          type: string
          example: Project can't be blank.
    ConfigurationModel:
      type: object
      properties:
        maximumAttachmentFileSize:
          type: integer
          description: The maximum allowed size of an attachment in Bytes
          readOnly: true
        hostName:
          type: string
          description: The host name configured for the system
          readOnly: true
        perPageOptions:
          type: array
          description: Page size steps to be offered in paginated list UI
          items:
            type: integer
        durationFormat:
          type: string
          description: The format used to display Work, Remaining Work, and Spent time durations
          readOnly: true
        activeFeatureFlags:
          type: array
          description: The list of all feature flags that are active
          items:
            type: string
    ProjectConfigurationModel:
      allOf:
      - $ref: '#/components/schemas/ConfigurationModel'
      - type: object
        properties:
          enabledInternalComments:
            type: boolean
            description: Whether internal comments are enabled for this project
            readOnly: true
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic