# OpenProject Portfolios API **Canonical:** https://apis.io/apis/openproject/openproject-portfolios-api/ **Provider:** OpenProject — https://apis.io/providers/openproject/ **Base URL:** https://community.openproject.org/api/v3 **Documentation:** https://www.openproject.org/docs/api/ OpenProject Portfolios 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 Portfolio. The published artifact set on APIs.io includes an OpenAPI specification and API documentation. Portfolios are one of the types of [workspaces](https://www.openproject.org/docs/api/endpoints/workspaces) in OpenProject structuring the information (e.g. work packages, wikis) into smaller sets. They are typically used to group, structure and manage sub-portfolios, programs and projects that target similar strategic goals of the organization. As containers, they also control behaviour of the elements within them. One of the most important aspects of this is that portfolios limit permissions by having members with a certain permission set (roles) assigned to them. ## Actions | Link | Description | Condition | |:--------------------------: |----------------------------------------------------------------------| --------------------------------- | | update | Form endpoint that aids in updating this portfolio | **Permission**: edit workspace | | updateImmediately | Directly update this portfolio | **Permission**: edit workspace | | delete | Delete this portfolio | **Permission**: admin | | favor | Mark this portfolio as favorited by the current user | **Permission**: none but login is required, only present if the portfolio is not yet favorited | | disfavor | Mark this portfolio as no longer favorited by the current user | **Permission**: none but login is required, only present if the portfolio is favorited | | createWorkPackage | Form endpoint that aids in preparing and creating a work package | **Permission**: add work packages | | createWorkPackageImmediately | Directly creates a work package in the portfolio | **Permission**: add work packages | ## Linked Properties | Link | Description | Type | Constraints | Supported operations |Condition | | :----------: | ------------- | ---- | ----------- | -------------------- |----------------------------------------- | | self | This portfolio | Portfolio | not null | READ | | | ancestors | Array of all ancestors of the portfolio, down from the root node (first element) to the parent (last element). | Collection | not null | READ | **Permission** view portfolio on the ancestor portfolio. Non visible portfolios will be omitted | | categories | Categories available in this portfolio | Collection | not null | READ | | | types | Types available in this portfolio | Collection | not null | READ | **Permission**: view work packages or manage types | | versions | Versions available in this portfolio | Collection | not null | READ | **Permission**: view work packages or manage versions | | memberships | Memberships in the portfolio | Collection | not null | READ | **Permission**: view members | | workPackages | Work Packages of this portfolio | Collection | not null | READ | | | parent | Parent portfolio of the portfolio | Portfolio | | READ/WRITE | **Permission** edit workspace | | status | Denotes the status of the portfolio, so whether the portfolio is on track, at risk or is having trouble. | PortfolioStatus | | READ/WRITE | **Permission** edit workspace | Depending on custom fields defined for portfolios, additional links might exist. Note, that the parent and ancestor links may contain the "undisclosed uri" `urn:openportfolio-org:api:v3:undisclosed` in case an ancestor portfolio is defined but the client lacks permission to see it. See the [general introduction into links' properties](https://www.openportfolio.org/docs/api/basic-objects/#local-properties) for more information. ## Local Properties | Property | Description | Type | Constraints | Supported operations | | :---------------------:| ------------- | ---- | ----------- | -------------------- | | id | Portfolios' id | Integer | x > 0 | READ/WRITE | | identifier | | String | | READ/WRITE | | name | | String | | READ/WRITE | | active | Indicates whether the portfolio is currently active or already archived | Boolean | | READ/WRITE | | favorited | Indicates whether the portfolio is favorited by the current user | Boolean | | READ | | statusExplanation | A text detailing and explaining why the portfolio has the reported status | Formattable | | READ/WRITE | | public | Indicates whether the portfolio is accessible for everybody | Boolean | | READ/WRITE | | description | | Formattable | | READ/WRITE | | createdAt | Time of creation | DateTime | | READ | | updatedAt | Time of the most recent change to the portfolio | DateTime | | READ | Depending on custom fields defined for portfolios, additional properties might exist. ## Machine-readable artifacts (5) - **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/openproject/refs/heads/main/openapi/openproject-portfolios-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 Portfolio --- Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/openproject/openproject-portfolios-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/openproject/.