v6 documentation is incomplete, want to contribute?

VRChat.community

API documentation, SDKs, and more
API Reference
Discord

List Notifications

Retrieve all of the current user's notifications.

Requests made through this page are proxied through an intermediary server due to Cross-Origin Resource Sharing restrictions.

GET
/auth/user/notifications

Authorization

auth<token>

Auth Token via Cookie

In: cookie

Query Parameters

type?stringDeprecated

Only send notifications of this type (can use all for all). This parameter no longer does anything, and is deprecated.

sent?booleanDeprecated

Return notifications sent by the user. Must be false or omitted.

hidden?boolean

Whether to return hidden or non-hidden notifications. True only allowed on type friendRequest.

after?string

Only return notifications sent after this Date. Ignored if type is friendRequest.

n?integer

The number of objects to return.

Default60
Range1 <= value <= 100
offset?integer

A zero-based offset from the default object sorting from where search results start.

Range0 <= value

Response Body

application/json

application/json

curl -X GET "https://api.vrchat.cloud/api/1/auth/user/notifications?type=all&sent=true&hidden=true&after=five_minutes_ago&n=60&offset=0"
[
  {
    "created_at": "2019-08-24T14:15:22Z",
    "details": "OneOf: {}, NotificationDetailInvite, NotificationDetailInviteResponse, NotificationDetailRequestInvite, NotificationDetailRequestInviteResponse, NotificationDetailVoteToKick",
    "id": "string",
    "message": "This is a generated invite to VRChat Hub",
    "seen": false,
    "receiverUserId": "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469",
    "senderUserId": "usr_c1644b5b-3ca4-45b4-97c6-a2a0de70d469",
    "senderUsername": "string",
    "type": "friendRequest"
  }
]

{
  "error": {
    "message": "\"Missing Credentials\"",
    "status_code": 401
  }
}