My Notifications

List my notifications

GET

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

curl -X GET 'https://peertube2.cpy.re/api/v1/users/me/notifications?count=15' \
  -H 'Authorization: Bearer YOUR_TOKEN'

const response = await fetch('https://peertube2.cpy.re/api/v1/users/me/notifications?count=15', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN',
  },
});

const data = await response.text();

import requests

response = requests.get(
    'https://peertube2.cpy.re/api/v1/users/me/notifications?count=15',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
    },
)
print(response.text)

200

{
  "total": 1,
  "data": [
    {
      "id": 42,
      "type": 1,
      "read": true,
      "video": {
        "name": "What is PeerTube?",
        "state": {
          "id": 1,
          "label": "string"
        },
        "channel": {
          "id": 42,
          "name": "string",
          "displayName": "string",
          "host": "example.com",
          "avatars": [
            {
              "path": "string",
              "fileUrl": "string",
              "width": 0,
              "height": 0,
              "createdAt": "2024-01-15T09:30:00Z",
              "updatedAt": "2024-01-15T09:30:00Z"
            }
          ]
        }
      },
      "videoImport": {
        "id": 42,
        "video": {
          "name": "What is PeerTube?",
          "state": {
            "id": 1,
            "label": "string"
          }
        },
        "torrentName": "string",
        "magnetUri": "https://example.com",
        "targetUri": "https://example.com"
      },
      "comment": {
        "id": 42,
        "threadId": 0,
        "video": {
          "name": "What is PeerTube?",
          "state": {
            "id": 1,
            "label": "string"
          }
        },
        "account": {
          "id": 42,
          "name": "string",
          "displayName": "string",
          "host": "example.com",
          "avatars": [
            {
              "path": "string",
              "fileUrl": "string",
              "width": 0,
              "height": 0,
              "createdAt": "2024-01-15T09:30:00Z",
              "updatedAt": "2024-01-15T09:30:00Z"
            }
          ]
        },
        "heldForReview": true
      },
      "videoAbuse": {
        "id": 42,
        "video": {
          "name": "What is PeerTube?",
          "state": {
            "id": 1,
            "label": "string"
          }
        }
      },
      "videoBlacklist": {
        "id": 42,
        "video": {
          "name": "What is PeerTube?",
          "state": {
            "id": 1,
            "label": "string"
          }
        }
      },
      "account": {
        "id": 42,
        "name": "string",
        "displayName": "string",
        "host": "example.com",
        "avatars": [
          {
            "path": "string",
            "fileUrl": "string",
            "width": 0,
            "height": 0,
            "createdAt": "2024-01-15T09:30:00Z",
            "updatedAt": "2024-01-15T09:30:00Z"
          }
        ]
      },
      "actorFollow": {
        "id": 42,
        "follower": {
          "id": 42,
          "name": "string",
          "displayName": "string",
          "host": "example.com",
          "avatars": [
            {
              "path": "string",
              "fileUrl": "string",
              "width": 0,
              "height": 0,
              "createdAt": "2024-01-15T09:30:00Z",
              "updatedAt": "2024-01-15T09:30:00Z"
            }
          ]
        },
        "state": "pending",
        "following": {
          "type": "account",
          "name": "string",
          "displayName": "string",
          "host": "example.com"
        }
      },
      "createdAt": "2024-01-15T09:30:00Z",
      "updatedAt": "2024-01-15T09:30:00Z"
    }
  ]
}

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

dataArray<Notification>

Show child attributes

idid>= 1

Example

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

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

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

Same fields as data.video.id

videoVideoInfo | null

Show child attributes

idid

object id for the video

Show child attributes

id>= 1

Example

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

Same fields as data.video.id

threadIdinteger

videoVideoInfo

Show child attributes

idid

object id for the video

Show child attributes

id>= 1

Example

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

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

Same fields as data.video.id

videoVideoInfo

Show child attributes

idid

object id for the video

Show child attributes

id>= 1

Example

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

Same fields as data.video.id

videoVideoInfo

Show child attributes

idid

object id for the video

Show child attributes

id>= 1

Example

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

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

Same fields as data.video.id

followerActorInfo

Show child attributes

idid>= 1

Example

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.

Docs by Sourcey