Memos

List User Notifications

ListUserNotifications lists a user's notifications. Only the user may call it. Notifications whose memos or space invitation the user can no longer read are left out.

GET
/api/users/{user}/notifications

Path Parameters

user*string

The user id.

Query Parameters

pageSize?integer

Optional. The maximum number of notifications to return. The service may return fewer. Currently ignored; all notifications are returned in one page.

Formatint32
pageToken?string

Optional. A page token from a previous call. Provide it to retrieve the next page.

filter?string

Optional. A filter on the notifications. Currently ignored.

Response Body

application/json

application/json

curl -X GET "https://example.com/api/users/string/notifications"
{  "notifications": [    {      "name": "string",      "sender": "string",      "senderUser": {        "name": "string",        "username": "string",        "displayName": "string",        "email": "string",        "avatarUrl": "string",        "description": "string",        "password": "string",        "role": "ROLE_UNSPECIFIED",        "state": "STATE_UNSPECIFIED",        "createTime": "2019-08-24T14:15:22Z",        "updateTime": "2019-08-24T14:15:22Z"      },      "type": "TYPE_UNSPECIFIED",      "memoComment": {        "memo": "string",        "relatedMemo": "string",        "memoSnippet": "string",        "relatedMemoSnippet": "string"      },      "memoMention": {        "memo": "string",        "relatedMemo": "string",        "memoSnippet": "string",        "relatedMemoSnippet": "string"      },      "spaceInvitation": {        "spaceInvitation": "string",        "space": {          "name": "string",          "title": "string",          "description": "string",          "icon": {            "emoji": "string",            "lucide": "string"          },          "currentUserRole": "ROLE_UNSPECIFIED",          "memberCount": 0        },        "role": "ROLE_UNSPECIFIED",        "state": "STATE_UNSPECIFIED"      },      "status": "STATUS_UNSPECIFIED",      "createTime": "2019-08-24T14:15:22Z"    }  ],  "nextPageToken": "string"}