OpenProject

OpenProject Root API

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 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 |

GitHub OpenAPI

Operations 1

GET /api/v3 View root #

Documentation

📖
Documentation
https://www.openproject.org/docs/api/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/openproject/refs/heads/main/openapi/openproject-root-api-openapi.yml

Other Resources

🔗
Introduction
https://www.openproject.org/docs/api/introduction/
🔗
Endpoints
https://www.openproject.org/docs/api/endpoints/
🔗
GitHub
https://github.com/opf/openproject

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-root-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

openproject-root-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  description: You're looking at the current **stable** documentation of the OpenProject APIv3.
  title: OpenProject API V3 (Stable) Root 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 root resource contains links to available resources in the API.
  name: Root
paths:
  /api/v3:
    get:
      summary: View root
      operationId: view_root
      description: Returns the root resource, containing basic information about the server instance and a collection of useful links.
      tags:
      - Root
      responses:
        '200':
          description: OK
          content:
            application/hal+json:
              schema:
                $ref: '#/components/schemas/RootModel'
components:
  schemas:
    Link:
      type: object
      required:
      - href
      properties:
        href:
          type:
          - string
          - 'null'
          description: URL to the referenced resource (might be relative)
        title:
          type: string
          description: Representative label for the resource
        templated:
          type: boolean
          default: false
          description: If true the href contains parts that need to be replaced by the client
        method:
          type: string
          default: GET
          description: The HTTP verb to use when requesting the resource
        payload:
          type: object
          description: The payload to send in the request to achieve the desired result
        identifier:
          type: string
          description: An optional unique identifier to the link object
        type:
          type: string
          description: The MIME-Type of the returned resource.
      example:
        href: /api/v3/work_packages
        method: POST
    RootModel:
      type: object
      required:
      - _type
      - instanceName
      - _links
      properties:
        _type:
          type: string
          enum:
          - Root
        instanceName:
          type: string
          description: The name of the OpenProject instance
        coreVersion:
          type: string
          description: 'The OpenProject core version number for the instance


            # Conditions


            **Permission** requires admin privileges'
        _links:
          type: object
          required:
          - self
          - configuration
          - memberships
          - priorities
          - relations
          - statuses
          - time_entries
          - types
          - user
          - userPreferences
          - workPackages
          properties:
            self:
              allOf:
              - $ref: '#/components/schemas/Link'
              - description: 'This root information object.


                  **Resource**: Root'
            configuration:
              allOf:
              - $ref: '#/components/schemas/Link'
              - description: 'The configuration resource.


                  **Resource**: Configuration'
            memberships:
              allOf:
              - $ref: '#/components/schemas/Link'
              - description: 'The collection of memberships.


                  **Resource**: Collection'
            priorities:
              allOf:
              - $ref: '#/components/schemas/Link'
              - description: 'The collection of priorities.


                  **Resource**: Collection'
            relations:
              allOf:
              - $ref: '#/components/schemas/Link'
              - description: 'The collection of relations.


                  **Resource**: Collection'
            statuses:
              allOf:
              - $ref: '#/components/schemas/Link'
              - description: 'The collection of statuses.


                  **Resource**: Collection'
            time_entries:
              allOf:
              - $ref: '#/components/schemas/Link'
              - description: 'The collection of time entries.


                  **Resource**: Collection'
            types:
              allOf:
              - $ref: '#/components/schemas/Link'
              - description: 'The collection of types.


                  **Resource**: Collection'
            user:
              allOf:
              - $ref: '#/components/schemas/Link'
              - description: 'The current user resource.


                  **Resource**: User'
            userPreferences:
              allOf:
              - $ref: '#/components/schemas/Link'
              - description: 'The current user preferences resource.


                  **Resource**: UserPreferences'
            workPackages:
              allOf:
              - $ref: '#/components/schemas/Link'
              - description: 'The work package collection.


                  **Resource**: Collection'
      example:
        _type: Root
        instanceName: OpenProject
        coreVersion: 12.1.0
        _links:
          self:
            href: /api/v3
          configuration:
            href: /api/v3/configuration
          memberships:
            href: /api/v3/memberships
          priorities:
            href: /api/v3/priorities
          relations:
            href: /api/v3/relations
          statuses:
            href: /api/v3/statuses
          time_entries:
            href: /api/v3/time_entries
          types:
            href: /api/v3/types
          user:
            href: /api/v3/users/3
            title: Anakin Skywalker
          userPreferences:
            href: /api/v3/users/3/preferences
          workPackages:
            href: /api/v3/work_packages
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic