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

PeerTube My Notifications API

Notifications following new videos, follows or reports. They allow you to keep track of the interactions and overall important information that concerns you. You MAY set per-notification type delivery preference, to receive the info either by mail, by in-browser notification or both.

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

Tagged areas include My Notifications. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and rate-limit docs.

This API exposes 4 operations across 4 paths, and defines 13 schemas. It is described by OpenAPI 3.0.3, at version 8.1.0.

Requests are made against 3 base URLs: https://peertube2.cpy.re, https://peertube3.cpy.re, https://peertube.cpy.re.

4 operations 4 paths 13 schemas 1 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
8.1.0
Base URL
https://{instance}/api/v1
Authentication
OAuth 2.0
License
Resource Areas
1

Authentication & Security 1

PeerTube My Notifications API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the password flow, exposing 3 scopes.

  • OAuth2 — Authenticating via OAuth requires the following steps: - Have an activated account - [Generate] an access token for that account at /api/v1/users/token. - Make…

Paths & Operations 4

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

My Notifications 4

Notifications following new videos, follows or reports. They allow you to keep track of the interactions and overall important information that concerns you. You MAY set per-notif…

GET
/api/v1/users/me/notifications
List my notifications
5 params → 200
POST
/api/v1/users/me/notifications/read
Mark notifications as read by their id
body → 204
POST
/api/v1/users/me/notifications/read-all
Mark all my notification as read
→ 204
PUT
/api/v1/users/me/notification-settings
Update my notification settings
body → 204

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are UserNotificationSettings (18 properties), Notification (12 properties), ActorImage (6 properties), ActorInfo (5 properties). Each schema is shown below with its type and property counts.

NotificationSettingValue
integer
Notification type. One of the following values, or a sum of multiple values: - 0 NONE - 1 WEB - 2 EMAIL
VideoStateConstant
object
2 properties
Notification
object
12 properties
NotificationListResponse
object
2 properties
Video
object
4 properties
VideoInfo
object
4 properties
ActorInfo
object
5 properties
id
integer
UserNotificationSettings
object
18 properties
ActorImage
object
6 properties
UUIDv4
string
NotificationType
integer
Notification type. One of the following values: - 1 NEWVIDEOFROMSUBSCRIPTION - 2 NEWCOMMENTONMYVIDEO - 3 NEWABUSEFORMODERATORS - 4 BLACKLISTONMYVIDEO - 5 UNBLA…
VideoImport
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

peertube-my-notifications-api-openapi.yml Raw ↑

Other APIs PeerTube publishes across the network.

PeerTube Abuses API
PeerTube Account Blocklist API
PeerTube Accounts API
PeerTube Automatic Tags API
PeerTube Channels Sync API
PeerTube Client Config API
PeerTube Config API
PeerTube Contact API
PeerTube Debug API
PeerTube Homepage API
PeerTube Instance Follows API
PeerTube Instance Redundancy API
Where this information came from

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