List my notifications

Live Test Server (live data - latest nightly version)

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

GET

/users/me/notifications

Request

Query Params

Responses

🟢200successful operation

application/json

Body

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
}

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

Update my notification settings

Mark notifications as read by their id