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

Forgejo notification API

The notification API from Forgejo — 4 operation(s) for notification.

Forgejo notification API is one of 10 APIs that Forgejo 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 4 paths, and defines 16 schemas. It is described by OpenAPI 2.0, at version 16.0.0-dev-465-4b83448b7d+gitea-1.22.0.

Requests are made against the base URL https://code.forgejo.org/api/v1.

7 operations 4 paths 16 schemas 4 GET1 PATCH2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
16.0.0-dev-465-4b83448b7d+gitea-1.22.0
Base URL
https://code.forgejo.org/api/v1
Authentication
API Key, basic, API Key, API Key, API Key
Resource Areas
1

Authentication & Security 5

Forgejo notification API declares 5 security schemes for authenticating requests. An API key is passed in the header as Authorization (AuthorizationHeaderToken). It defines a basic scheme (BasicAuth). An API key is passed in the header as Sudo (SudoHeader). An API key is passed in the query as sudo (SudoParam). An API key is passed in the header as X-FORGEJO-OTP (TOTPHeader). By default, every request must be authenticated.

  • AuthorizationHeaderToken — API tokens must be prepended with "token" followed by a space.
  • SudoHeader — Sudo API request as the user provided as the key. Admin privileges are required.
  • SudoParam — Sudo API request as the user provided as the key. Admin privileges are required.
  • TOTPHeader — Must be used in combination with BasicAuth if two-factor authentication is enabled.

Paths & Operations 7

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

notification 7
GET
/notifications
List users's notification threads
notifyGetList 7 params → 200
PUT
/notifications
Mark notification threads as read, pinned or unread
notifyReadList 4 params → 205
GET
/notifications/new
Check if unread notifications exist
notifyNewAvailable → 200
GET
/notifications/threads/{id}
Get notification thread by ID
notifyGetThread 1 param → 200403404
PATCH
/notifications/threads/{id}
Mark notification thread as read by ID
notifyReadThread 2 params → 205403404
GET
/repos/{owner}/{repo}/notifications
List users's notification threads on a specific repo
notifyGetRepoList 9 params → 200
PUT
/repos/{owner}/{repo}/notifications
Mark notification threads as read, pinned or unread on a specific repo
notifyReadRepoList 6 params → 205

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are Repository (66 properties), User (23 properties), Organization (12 properties), Team (9 properties). Each schema is shown below with its type and property counts.

Team
object
Team represents a team in an organization
9 properties
Organization
object
Organization represents an organization
12 properties
Permission
object
Permission represents a set of permissions
3 properties
User
object
User represents a user
23 properties
APIForbiddenError
object
2 properties
APINotFound
object
3 properties
NotificationSubject
object
NotificationSubject contains the notification subject (Issue/Pull/Commit)
7 properties
ExternalWiki
object
ExternalWiki represents setting for external wiki
1 property
NotifySubjectType
string
NotifySubjectType represent type of notification subject
InternalTracker
object
InternalTracker represents settings for internal tracker
3 properties
ExternalTracker
object
ExternalTracker represents settings for external tracker
4 properties
RepoTransfer
object
RepoTransfer represents a pending repo transfer
3 properties
StateType
string
StateType issue state type
Repository
object
Repository represents a repository
66 properties
NotificationThread
object
NotificationThread expose Notification on API
7 properties
NotificationCount
object
NotificationCount number of unread notifications
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

forgejo-notification-api-openapi.yml Raw ↑

Other APIs Forgejo publishes across the network.

Forgejo activitypub API
Forgejo admin API
Forgejo issue API
Forgejo miscellaneous API
Forgejo organization API
Forgejo package API
Forgejo repository API
Forgejo settings API
Forgejo user API
Where this information came from

This is an independent, third-party profile of Forgejo notification 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.