Accounts

My Notifications

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.

List my notifications

GET
https://peertube2.cpy.re/api/v1/users/me/notifications

Parameters

typeOneOfArray<NotificationType>12345678910111213141516171819202122232425262728293031323334query

only list notifications of these types

unreadbooleanquery

only list unread notifications

startinteger>= 0query

Offset used to paginate results

countinteger[1, 100]15query

Number of items to return

sortstringquery

Sort column

Response

200OKNotificationListResponse

successful operation

Response fields application/json
totalinteger
Example
1
dataArray<Notification>
Show child attributes
idid>= 1
Example
42
typeNotificationType12345678910111213141516171819202122232425262728293031323334

Notification type. One of the following values:

  • 1 NEW_VIDEO_FROM_SUBSCRIPTION

  • 2 NEW_COMMENT_ON_MY_VIDEO

  • 3 NEW_ABUSE_FOR_MODERATORS

  • 4 BLACKLIST_ON_MY_VIDEO

  • 5 UNBLACKLIST_ON_MY_VIDEO

  • 6 MY_VIDEO_PUBLISHED

  • 7 MY_VIDEO_IMPORT_SUCCESS

  • 8 MY_VIDEO_IMPORT_ERROR

  • 9 NEW_USER_REGISTRATION

  • 10 NEW_FOLLOW

  • 11 COMMENT_MENTION

  • 12 VIDEO_AUTO_BLACKLIST_FOR_MODERATORS

  • 13 NEW_INSTANCE_FOLLOWER

  • 14 AUTO_INSTANCE_FOLLOWING

  • 15 ABUSE_STATE_CHANGE

  • 16 ABUSE_NEW_MESSAGE

  • 17 NEW_PLUGIN_VERSION

  • 18 NEW_PEERTUBE_VERSION

  • 19 MY_VIDEO_STUDIO_EDITION_FINISHED

  • 20 NEW_USER_REGISTRATION_REQUEST

  • 21 NEW_LIVE_FROM_SUBSCRIPTION

  • 22 MY_VIDEO_TRANSCRIPTION_GENERATED

  • 23 INVITED_TO_COLLABORATE_TO_CHANNEL

  • 24 ACCEPTED_TO_COLLABORATE_TO_CHANNEL

  • 25 REFUSED_TO_COLLABORATE_TO_CHANNEL

  • 26 VIDEO_OWNERSHIP_CHANGED_REQUEST

  • 27 VIDEO_OWNERSHIP_CHANGED_ACCEPTED

  • 28 VIDEO_OWNERSHIP_CHANGED_REJECTED

  • 29 CHANNEL_OWNERSHIP_CHANGED_REQUEST

  • 30 CHANNEL_OWNERSHIP_CHANGED_ACCEPTED

  • 31 CHANNEL_OWNERSHIP_CHANGED_REJECTED

  • 32 AUTOMATIC_BLOCKLIST_UPDATE

  • 33 MY_VIDEO_STUDIO_EDITION_ERROR

  • 34 MY_VIDEO_DUPLICATION_ERROR

readboolean
videoVideoInfo & object | null
Show child attributes
idid

object id for the video

Show child attributes
id>= 1
Example
42
uuidUUIDv4

universal identifier for the video, that can be used across instances

Show child attributes
UUIDv4<uuid>
Example
9c9de5e8-0a1e-484a-b099-e80766180a6d
namename

title of the video

Example
What is PeerTube?
stateVideoStateConstant

represents the internal state of the video processing within the PeerTube instance

Show child attributes
idid123456789101112131415

The video state:

  • 1: Published
  • 2: To transcode
  • 3: To import
  • 4: Waiting for live stream
  • 5: Live ended
  • 6: To move to an external storage (object storage...)
  • 7: Transcoding failed
  • 8: Moving to an external storage failed
  • 9: To edit using studio edition feature
  • 10: To move to the file system
  • 11: Moving to the file system failed
  • 12: Import failed
  • 13: To duplicate, the files of another video are being copied
  • 14: Duplication failed, the files of the other video could not be copied
  • 15: The studio edition of a video saved as a new video failed

Same fields as data.video.id

labelstring
channelActorInfo
Show child attributes
idid>= 1
Example
42

Same fields as data.video.id

namestring
displayNamestring
hoststring<hostname>
avatarsArray<ActorImage>
Show child attributes
pathstring | nulldeprecated

Deprecated in PeerTube v8.0, use fileUrl instead. Null if the file is stored in object storage: use the non-deprecated field instead.

fileUrlstring

PeerTube >= 7.1

widthinteger
heightinteger

PeerTube >= 7.3

createdAtstring<date-time>
updatedAtstring<date-time>
videoImportobject | null
Show child attributes
idid>= 1
Example
42

Same fields as data.video.id

videoVideoInfo | null
Show child attributes
idid

object id for the video

Show child attributes
id>= 1
Example
42
uuidUUIDv4

universal identifier for the video, that can be used across instances

Show child attributes
UUIDv4<uuid>
Example
9c9de5e8-0a1e-484a-b099-e80766180a6d
namename

title of the video

Example
What is PeerTube?
stateVideoStateConstant

represents the internal state of the video processing within the PeerTube instance

Show child attributes
idid123456789101112131415

The video state:

  • 1: Published
  • 2: To transcode
  • 3: To import
  • 4: Waiting for live stream
  • 5: Live ended
  • 6: To move to an external storage (object storage...)
  • 7: Transcoding failed
  • 8: Moving to an external storage failed
  • 9: To edit using studio edition feature
  • 10: To move to the file system
  • 11: Moving to the file system failed
  • 12: Import failed
  • 13: To duplicate, the files of another video are being copied
  • 14: Duplication failed, the files of the other video could not be copied
  • 15: The studio edition of a video saved as a new video failed

Same fields as data.video.id

labelstring
torrentNamestring | null
magnetUrimagnetUri<uri>

magnet URI allowing to resolve the import's source video

targetUristring<uri> | null
commentobject | null
Show child attributes
idid>= 1
Example
42

Same fields as data.video.id

threadIdinteger
videoVideoInfo
Show child attributes
idid

object id for the video

Show child attributes
id>= 1
Example
42
uuidUUIDv4

universal identifier for the video, that can be used across instances

Show child attributes
UUIDv4<uuid>
Example
9c9de5e8-0a1e-484a-b099-e80766180a6d
namename

title of the video

Example
What is PeerTube?
stateVideoStateConstant

represents the internal state of the video processing within the PeerTube instance

Show child attributes
idid123456789101112131415

The video state:

  • 1: Published
  • 2: To transcode
  • 3: To import
  • 4: Waiting for live stream
  • 5: Live ended
  • 6: To move to an external storage (object storage...)
  • 7: Transcoding failed
  • 8: Moving to an external storage failed
  • 9: To edit using studio edition feature
  • 10: To move to the file system
  • 11: Moving to the file system failed
  • 12: Import failed
  • 13: To duplicate, the files of another video are being copied
  • 14: Duplication failed, the files of the other video could not be copied
  • 15: The studio edition of a video saved as a new video failed

Same fields as data.video.id

labelstring
accountActorInfo
Show child attributes
idid>= 1
Example
42

Same fields as data.video.id

namestring
displayNamestring
hoststring<hostname>
avatarsArray<ActorImage>
Show child attributes
pathstring | nulldeprecated

Deprecated in PeerTube v8.0, use fileUrl instead. Null if the file is stored in object storage: use the non-deprecated field instead.

fileUrlstring

PeerTube >= 7.1

widthinteger
heightinteger

PeerTube >= 7.3

createdAtstring<date-time>
updatedAtstring<date-time>
heldForReviewboolean
videoAbuseobject | null
Show child attributes
idid>= 1
Example
42

Same fields as data.video.id

videoVideoInfo
Show child attributes
idid

object id for the video

Show child attributes
id>= 1
Example
42
uuidUUIDv4

universal identifier for the video, that can be used across instances

Show child attributes
UUIDv4<uuid>
Example
9c9de5e8-0a1e-484a-b099-e80766180a6d
namename

title of the video

Example
What is PeerTube?
stateVideoStateConstant

represents the internal state of the video processing within the PeerTube instance

Show child attributes
idid123456789101112131415

The video state:

  • 1: Published
  • 2: To transcode
  • 3: To import
  • 4: Waiting for live stream
  • 5: Live ended
  • 6: To move to an external storage (object storage...)
  • 7: Transcoding failed
  • 8: Moving to an external storage failed
  • 9: To edit using studio edition feature
  • 10: To move to the file system
  • 11: Moving to the file system failed
  • 12: Import failed
  • 13: To duplicate, the files of another video are being copied
  • 14: Duplication failed, the files of the other video could not be copied
  • 15: The studio edition of a video saved as a new video failed

Same fields as data.video.id

labelstring
videoBlacklistobject | null
Show child attributes
idid>= 1
Example
42

Same fields as data.video.id

videoVideoInfo
Show child attributes
idid

object id for the video

Show child attributes
id>= 1
Example
42
uuidUUIDv4

universal identifier for the video, that can be used across instances

Show child attributes
UUIDv4<uuid>
Example
9c9de5e8-0a1e-484a-b099-e80766180a6d
namename

title of the video

Example
What is PeerTube?
stateVideoStateConstant

represents the internal state of the video processing within the PeerTube instance

Show child attributes
idid123456789101112131415

The video state:

  • 1: Published
  • 2: To transcode
  • 3: To import
  • 4: Waiting for live stream
  • 5: Live ended
  • 6: To move to an external storage (object storage...)
  • 7: Transcoding failed
  • 8: Moving to an external storage failed
  • 9: To edit using studio edition feature
  • 10: To move to the file system
  • 11: Moving to the file system failed
  • 12: Import failed
  • 13: To duplicate, the files of another video are being copied
  • 14: Duplication failed, the files of the other video could not be copied
  • 15: The studio edition of a video saved as a new video failed

Same fields as data.video.id

labelstring
accountActorInfo | null
Show child attributes
idid>= 1
Example
42

Same fields as data.video.id

namestring
displayNamestring
hoststring<hostname>
avatarsArray<ActorImage>
Show child attributes
pathstring | nulldeprecated

Deprecated in PeerTube v8.0, use fileUrl instead. Null if the file is stored in object storage: use the non-deprecated field instead.

fileUrlstring

PeerTube >= 7.1

widthinteger
heightinteger

PeerTube >= 7.3

createdAtstring<date-time>
updatedAtstring<date-time>
actorFollowobject | null
Show child attributes
idid>= 1
Example
42

Same fields as data.video.id

followerActorInfo
Show child attributes
idid>= 1
Example
42

Same fields as data.video.id

namestring
displayNamestring
hoststring<hostname>
avatarsArray<ActorImage>
Show child attributes
pathstring | nulldeprecated

Deprecated in PeerTube v8.0, use fileUrl instead. Null if the file is stored in object storage: use the non-deprecated field instead.

fileUrlstring

PeerTube >= 7.1

widthinteger
heightinteger

PeerTube >= 7.3

createdAtstring<date-time>
updatedAtstring<date-time>
statestringpendingaccepted
followingobject
Show child attributes
typestringaccountchannelinstance
namestring
displayNamestring
hoststring<hostname>
createdAtstring<date-time>
updatedAtstring<date-time>

Authorization

OAuth2oauth2

Authenticating via OAuth requires the following steps:

  • Have an activated account
  • Generate an access token for that account at /api/v1/users/token.
  • Make requests with the Authorization: Bearer <token> header
  • Profit, depending on the role assigned to the account

Note that the access token is valid for 1 day and is given along with a refresh token valid for 2 weeks.

Mark notifications as read by their id

POST
https://peertube2.cpy.re/api/v1/users/me/notifications/read

Body

application/json
idsArray<integer>required

ids of the notifications to mark as read

Response

204No Content

successful operation

Authorization

OAuth2oauth2

Authenticating via OAuth requires the following steps:

  • Have an activated account
  • Generate an access token for that account at /api/v1/users/token.
  • Make requests with the Authorization: Bearer <token> header
  • Profit, depending on the role assigned to the account

Note that the access token is valid for 1 day and is given along with a refresh token valid for 2 weeks.

Mark all my notification as read

POST
https://peertube2.cpy.re/api/v1/users/me/notifications/read-all

Response

204No Content

successful operation

Authorization

OAuth2oauth2

Authenticating via OAuth requires the following steps:

  • Have an activated account
  • Generate an access token for that account at /api/v1/users/token.
  • Make requests with the Authorization: Bearer <token> header
  • Profit, depending on the role assigned to the account

Note that the access token is valid for 1 day and is given along with a refresh token valid for 2 weeks.

Update my notification settings

PUT
https://peertube2.cpy.re/api/v1/users/me/notification-settings

Body

application/json
abuseAsModeratorNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

  • 0 NONE
  • 1 WEB
  • 2 EMAIL
videoAutoBlacklistAsModeratorNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

  • 0 NONE
  • 1 WEB
  • 2 EMAIL
newUserRegistrationNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

  • 0 NONE
  • 1 WEB
  • 2 EMAIL
newVideoFromSubscriptionNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

  • 0 NONE
  • 1 WEB
  • 2 EMAIL
blacklistOnMyVideoNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

  • 0 NONE
  • 1 WEB
  • 2 EMAIL
myVideoPublishedNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

  • 0 NONE
  • 1 WEB
  • 2 EMAIL
myVideoImportFinishedNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

  • 0 NONE
  • 1 WEB
  • 2 EMAIL
commentMentionNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

  • 0 NONE
  • 1 WEB
  • 2 EMAIL
newCommentOnMyVideoNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

  • 0 NONE
  • 1 WEB
  • 2 EMAIL
newFollowNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

  • 0 NONE
  • 1 WEB
  • 2 EMAIL
newInstanceFollowerNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

  • 0 NONE
  • 1 WEB
  • 2 EMAIL
autoInstanceFollowingNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

  • 0 NONE
  • 1 WEB
  • 2 EMAIL
abuseStateChangeNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

  • 0 NONE
  • 1 WEB
  • 2 EMAIL
abuseNewMessageNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

  • 0 NONE
  • 1 WEB
  • 2 EMAIL
newPeerTubeVersionNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

  • 0 NONE
  • 1 WEB
  • 2 EMAIL
newPluginVersionNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

  • 0 NONE
  • 1 WEB
  • 2 EMAIL
myVideoStudioEditionFinishedNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

  • 0 NONE
  • 1 WEB
  • 2 EMAIL
myVideoTranscriptionGeneratedNotificationSettingValue

Notification type. One of the following values, or a sum of multiple values:

  • 0 NONE
  • 1 WEB
  • 2 EMAIL

Response

204No Content

successful operation

Authorization

OAuth2oauth2

Authenticating via OAuth requires the following steps:

  • Have an activated account
  • Generate an access token for that account at /api/v1/users/token.
  • Make requests with the Authorization: Bearer <token> header
  • Profit, depending on the role assigned to the account

Note that the access token is valid for 1 day and is given along with a refresh token valid for 2 weeks.

Docs by Sourcey
↑↓ navigate↵ selectesc close