OpenProject

OpenProject Relations API

Work packages may be related to each other in different ways. ``` +--------------+ +--------------+ | | 1 1 | | | Work package +-------------+--------------+ Work package | | | from | to | | +--------------+ | +--------------+ +------+-------+ | Relation | +--------------+ | type | | reverseType | | description | | lag | +--------------+ ``` ## Actions | Link | Description | Condition | |:-------------------:| -------------------------------------------------------------------- | --------------------------------------------- | | update | Updates the relation between two work packages via a form | **Permission**: manage work package relations | | updateImmediately | Updates the relation between two work packages | **Permission**: manage work package relations | | delete | Destroys the relation between the two work packages | **Permission**: manage work package relations | ## Linked Properties | Link | Description | Type | Constraints | Supported operations | Condition | |:-------------:|-------------------------------------- | ------------- | ----------- | -------------------- | --------------------------------------------- | | self | This relation | Relation | not null | READ | **Permission**: view work packages | | schema | The schema of this relation | Schema | not null | READ | | | from | The emanating work package | WorkPackage | not null | READ | **Permission**: view work packages | | to | The work package the relation ends in | WorkPackage | not null | READ | **Permission**: view work packages | ## Local Properties | Property | Description | Type | Constraints | Supported operations | | :---------------:| ------------------------------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------- | -------------------- | | id | Relation ID | Integer | x > 0 | READ | | name | The internationalized name of this kind of relation | String | | READ | type | Which kind of relation (blocks, precedes, etc.) | String | in: relates, duplicates, duplicated, blocks, blocked, precedes, follows, includes, partof, requires, required | READ / WRITE | | reverseType | The kind of relation from the other WP's perspective | String | in: relates, duplicates, duplicated, blocks, blocked, precedes, follows, includes, partof, requires, required | READ | | description | Short text further describing the relation | String | | READ / WRITE | | lag* | The number of days between closing of `from` and start of `to`| Integer | x >= 0 | READ / WRITE | \* Only applicable for some relation types such as "follows". You can check using the relation by schema endpoint at `/api/v3/relations/schema/{type}`.

GitHub OpenAPI

Operations 5

GET /api/v3/relations List Relations #
GET /api/v3/relations/{id} Get Relation #
DELETE /api/v3/relations/{id} Delete Relation #
PATCH /api/v3/relations/{id} Update Relation #
POST /api/v3/work_packages/{id}/relations Create relation #

Documentation

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

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/openproject/refs/heads/main/openapi/openproject-relations-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-relations-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-relations-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) Relations 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:


# --- truncated at 32 KB (47 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/openproject/refs/heads/main/openapi/openproject-relations-api-openapi.yml