PeerTube

List my notifications

Live Test Server (live data - latest nightly version)

https://peertube2.cpy.re/api/v1

GET

/users/me/notifications

My Notifications

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://peertube2.cpy.re/api/v1/users/me/notifications'

Response Example

{
    "data": [
        {
            "account": {
                "avatar": {
                    "path": "string"
                },
                "displayName": "string",
                "host": "example.com",
                "id": 42,
                "name": "string"
            },
            "actorFollow": {
                "follower": {
                    "avatar": {
                        "path": "string"
                    },
                    "displayName": "string",
                    "host": "example.com",
                    "id": 42,
                    "name": "string"
                },
                "following": {
                    "displayName": "string",
                    "host": "example.com",
                    "name": "string",
                    "type": "account"
                },
                "id": 42,
                "state": "pending"
            },
            "comment": {
                "account": {
                    "avatar": {
                        "path": "string"
                    },
                    "displayName": "string",
                    "host": "example.com",
                    "id": 42,
                    "name": "string"
                },
                "id": 42,
                "threadId": 0,
                "video": {
                    "id": {},
                    "name": {},
                    "uuid": {}
                }
            },
            "createdAt": "2019-08-24T14:15:22Z",
            "id": 42,
            "read": true,
            "type": 0,
            "updatedAt": "2019-08-24T14:15:22Z",
            "video": {
                "id": {},
                "name": {},
                "uuid": {},
                "channel": {
                    "avatar": {
                        "path": "string"
                    },
                    "displayName": "string",
                    "host": "example.com",
                    "id": 42,
                    "name": "string"
                }
            },
            "videoAbuse": {
                "id": 42,
                "video": {
                    "id": {},
                    "name": {},
                    "uuid": {}
                }
            },
            "videoBlacklist": {
                "id": 42,
                "video": {
                    "id": {},
                    "name": {},
                    "uuid": {}
                }
            },
            "videoImport": {
                "id": 42,
                "magnetUri": {},
                "targetUri": "http://example.com",
                "torrentName": "string",
                "video": {
                    "id": {},
                    "name": {},
                    "uuid": {}
                }
            }
        }
    ],
    "total": 1
}

Request

Query Params

unread

string

optional

only list unread notifications

start

integer

optional

Offset used to paginate results

count

integer

optional

Number of items to return

sort

string

optional

Sort column

Responses

🟢200successful operation

application/json

Body

data

array[object (Notification) {12}]

optional

<= 100 items

account

null | allOf {1}

optional

actorFollow

object | null

optional

comment

object | null

optional

createdAt

string <date-time>

optional

integer

optional

>= 1

Example:

read

boolean

optional

type

integer

optional

Notification type, following the UserNotificationType enum:

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

updatedAt

string <date-time>

optional

video

null | allOf {2}

optional

videoAbuse

object | null

optional

videoBlacklist

object | null

optional

videoImport

object | null

optional

total

integer

optional

Example:

Modified at 2022-09-10 22:29:50

Update my notification settings

Mark notifications as read by their id