# OpenProject Root API

**Canonical:** https://apis.io/apis/openproject/openproject-root-api/  
**Provider:** OpenProject — https://apis.io/providers/openproject/  
**Base URL:** https://community.openproject.org/api/v3  
**Documentation:** https://www.openproject.org/docs/api/

OpenProject Root API is one of 62 APIs that [OpenProject](https://apis.io/providers/openproject/) publishes on the [APIs.io](https://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.

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 |

## Machine-readable artifacts (5)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/openproject/refs/heads/main/openapi/openproject-root-api-openapi.yml
- **Documentation** — https://www.openproject.org/docs/api/
- **Introduction** — https://www.openproject.org/docs/api/introduction/
- **Endpoints** — https://www.openproject.org/docs/api/endpoints/
- **GitHub** — https://github.com/opf/openproject

## Other OpenProject APIs (12)

- [OpenProject Actions & Capabilities API](https://apis.io/apis/openproject/openproject-actions-capabilities-api/)
- [OpenProject Activities API](https://apis.io/apis/openproject/openproject-activities-api/)
- [OpenProject Attachments API](https://apis.io/apis/openproject/openproject-attachments-api/)
- [OpenProject Budgets API](https://apis.io/apis/openproject/openproject-budgets-api/)
- [OpenProject Categories API](https://apis.io/apis/openproject/openproject-categories-api/)
- [OpenProject Collections API](https://apis.io/apis/openproject/openproject-collections-api/)
- [OpenProject Configuration API](https://apis.io/apis/openproject/openproject-configuration-api/)
- [OpenProject Custom actions API](https://apis.io/apis/openproject/openproject-custom-actions-api/)
- [OpenProject Custom Field Items API](https://apis.io/apis/openproject/openproject-custom-field-items-api/)
- [OpenProject Custom Fields API](https://apis.io/apis/openproject/openproject-custom-fields-api/)
- [OpenProject Custom Options API](https://apis.io/apis/openproject/openproject-custom-options-api/)
- [OpenProject Documents API](https://apis.io/apis/openproject/openproject-documents-api/)

## Tags

Root

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/openproject/openproject-root-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/openproject/.