How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
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 becauseof 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 | |

Documentation Provider Profile APIs.io OpenAPI GitHub

OpenProject Notifications API is one of 62 APIs that OpenProject publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Notification. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 7 operations across 7 paths, and defines 22 schemas. It is described by OpenAPI 3.1.2, at version 3.

Requests are made against 3 base URLs: https://qa.openproject-edge.com, https://qa.openproject-stage.com, https://community.openproject.org.

7 operations 7 paths 22 schemas 3 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.2
API Version
3
Base URL
https://community.openproject.org/api/v3
Authentication
HTTP Basic
Resource Areas
1

Authentication & Security 1

OpenProject Notifications API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (BasicAuth). By default, every request must be authenticated.

Paths & Operations 7

Across 7 paths, the API surfaces 7 operations — 3 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.

Notifications 7

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 ca…

GET
/api/v3/notifications
Get notification collection
list_notifications 5 params → 200403422
POST
/api/v3/notifications/read_ian
Read all notifications
read_notifications 1 param → 204400406415
POST
/api/v3/notifications/unread_ian
Unread all notifications
unread_notifications 1 param → 204400406415
GET
/api/v3/notifications/{id}
Get the notification
view_notification 1 param → 200404
GET
/api/v3/notifications/{notification_id}/details/{id}
Get a notification detail
view_notification_detail 2 params → 200404
POST
/api/v3/notifications/{id}/read_ian
Read notification
read_notification 1 param → 204404
POST
/api/v3/notifications/{id}/unread_ian
Unread notification
unread_notification 1 param → 204404

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are ActivityModel (10 properties), NotificationModel (9 properties), AttachmentModel (9 properties), EmojiReactionModel (7 properties). Each schema is shown below with its type and property counts.

ValuesPropertyModel
object
4 properties 4 required
CollectionModel
object
4 properties 4 required
Link
object
7 properties 1 required
SchemaModel
object
3 properties 2 required
WorkPackageModel
PortfolioModel
PrincipalModel
object
6 properties 4 required
EmojiReactions_Model
object
5 properties
CollectionLinks
object
1 property 1 required
NotificationModel
object
9 properties
EmojiReactionModel
object
7 properties
ActivityModel
object
10 properties
NotificationCollectionModel
Formattable
object
3 properties 1 required
Attachments_Model
ErrorResponse
object
4 properties 3 required
ProgramModel
AttachmentModel
object
9 properties 6 required
UserModel
CustomCommentProperties
object
ProjectModel
CustomFieldProperties
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

openproject-notifications-api-openapi.yml Raw ↑

Other APIs OpenProject publishes across the network.

OpenProject Actions & Capabilities API
AE Profile APIs.io
OpenProject Activities API
AE Profile APIs.io
OpenProject Attachments API
AE Profile APIs.io
OpenProject Budgets API
AE Profile APIs.io
OpenProject Categories API
AE Profile APIs.io
OpenProject Collections API
AE Profile APIs.io
OpenProject Configuration API
AE Profile APIs.io
OpenProject Custom actions API
AE Profile APIs.io
OpenProject Custom Field Items API
AE Profile APIs.io
OpenProject Custom Fields API
AE Profile APIs.io
OpenProject Custom Options API
AE Profile APIs.io
OpenProject Documents API
AE Profile APIs.io
#Notification
← Back to O APIs
API Details
ID
openproject:openproject-notifications-api
Base URL
https://community.openproject.org/api/v3
Docs
https://www.openproject.org/docs/api/
Provider
OpenProject
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=openproject-notifications-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/openproject-notifications-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of OpenProject Notifications API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.