docs/api/README.md
OpenProject offers different APIs:
Please note that we intend to keep this specification as accurate and stable as possible, however work on APIs is still ongoing and not all resources and actions in OpenProject are yet accessible through the APIs.
This document will be subject to changes as we add more endpoints and functionality. The development version of this document may have breaking changes while we work on new endpoints for the application.
The API v3 is a general purpose API supporting multiple use cases.
While by no means complete, a whole lot of different scenarios can be automatized which otherwise would have to be carried out by hand via the UI. Examples for this include managing work packages, projects and users.
We strive to maintain backward compatibility with this API in our stable OpenProject releases whenever possible.
Download the API specification in OpenAPI format as json or yml.
OpenProject allows to manage users and groups using System for Cross-domain Identity Management. This is a standardized API (see RFC 7643 and RFC 7644) that might thus be supported by existing identity providers.
➔ Read more on configuration instructions
A growing number of tools and resources is offered through the Model Context Protocol API of OpenProject. This API is primarily targeted at AI agents and similar tools, as it supports auto-discovery of supported operations.
➔ Read more on configuration instructions
This API supports BCF management in the context of BIM projects.
While this API supports way less use cases than the more generic API v3 it is compatible with the generic specification of a BCF API as defined by the standard. Clients implementing the specification can manage topics and viewpoints.