OpenProject

OpenProject Notifications API

Notifications are created through notifiable actions in OpenProject. Notifications are triggered by actions carried out in the system by users, e.g. editing a work package, but can also be send out because of time passing e.g. when a user is notified of a work package that is overdue. This endpoint only returns in-app notifications. ## Actions | Link | Description | Condition | |:-------------------:| -------------------------------------------------------------------- | --------------------------- | | read_ian | Marks the notification as read | notification is unread | | unread_ian | Marks the notification as unread | notification is read | ## Linked Properties | Link | Description | Type | Constraints | Supported operations | Condition | | :-----------: | ---------------------------------------- | -------------- | --------------------- | -------------------- | ----------------------------------------- | | self | This notification | Notification | not null | READ | | | project | The project containing the resource | Project | not null | READ | | | actor | The user that caused the notification | User | | READ | optional | | resource | The resource the notification belongs to | Polymorphic | not null | READ | | | activity | The journal the notification belongs to | Polymorphic | | READ | optional | | details | A list of objects including detailed information | Polymorphic | | READ | optional | ## Local Properties | Property | Description | Type | Constraints | Supported operations | Condition | | :----------: | --------------------------------------------------------- | -------- | ---------------------------------------------------- | -------------------- | ----------------------------------------------------------- | | id | Primary key | Integer | | READ | | | subject | The subject of the notification | String | | READ | | | reason | The reason causing the notification | String | | READ | | | readIAN | Whether the notification is read | Boolean | | READ | |

GitHub OpenAPI

Operations 7

GET /api/v3/notifications Get notification collection #
POST /api/v3/notifications/read_ian Read all notifications #
POST /api/v3/notifications/unread_ian Unread all notifications #
GET /api/v3/notifications/{id} Get the notification #
GET /api/v3/notifications/{notification_id}/details/{id} Get a notification detail #
POST /api/v3/notifications/{id}/read_ian Read notification #
POST /api/v3/notifications/{id}/unread_ian Unread notification #

Documentation

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

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/openproject/refs/heads/main/openapi/openproject-notifications-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-notifications-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-notifications-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) Notifications 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 (94 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/openproject/refs/heads/main/openapi/openproject-notifications-api-openapi.yml