Skip to main content
GET
/
api
/
v1
/
notification-tray
Get user's notification tray items
curl --request GET \
  --url https://apix.us.amity.co/api/v1/notification-tray \
  --header 'Authorization: Bearer <token>'
{
  "notificationTrayItems": [
    {
      "_id": "<string>",
      "daySegment": "2023-11-07T05:31:56Z",
      "lastSeenAt": "2023-11-07T05:31:56Z",
      "lastOccurredAt": "2023-11-07T05:31:56Z",
      "actors": [
        {
          "_id": "<string>",
          "publicId": "<string>",
          "lastActedAt": "2023-11-07T05:31:56Z"
        }
      ],
      "actorsCount": 123,
      "targetId": "<string>",
      "targetType": "<string>",
      "text": "Alice and 4 others reacted to a comment on their feed",
      "templatedText": "{{ userId: AlicePublicId }} and {{ text: 4 others }} reacted to a comment on their feed",
      "referenceId": "<string>",
      "referenceType": "<string>",
      "actionReferenceId": "<string>",
      "parentId": "<string>",
      "data": {
        "communityName": "<string>"
      }
    }
  ],
  "users": [
    {
      "userId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "_id": "<string>",
      "path": "<string>",
      "userInternalId": "<string>",
      "userPublicId": "<string>",
      "roles": [
        "<string>"
      ],
      "permissions": [],
      "displayName": "<string>",
      "profileHandle": "<string>",
      "description": "<string>",
      "avatarFileId": "<string>",
      "avatarCustomUrl": "<string>",
      "flagCount": 123,
      "hashFlag": {
        "bits": 123,
        "hashes": 123,
        "hash": [
          "<string>"
        ]
      },
      "metadata": {},
      "isGlobalBan": true,
      "isBrand": true,
      "isDeleted": true
    }
  ],
  "paging": {
    "limit": 123,
    "next": "<string>",
    "previous": "<string>"
  },
  "files": [
    {
      "fileId": "<string>",
      "fileUrl": "<string>",
      "accessType": "public",
      "altText": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "attributes": {
        "name": "<string>",
        "extension": "<string>",
        "size": 123,
        "mimeType": "<string>",
        "metadata": {
          "exif": {},
          "gps": {},
          "height": 123,
          "width": 123,
          "isFull": true
        }
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
options
object

Pagination options for controlling result set size and navigation

Response

Response containing a list of notification tray items and associated data

​
notificationTrayItems
object[]
required

List of notification items to display

​
users
object[]
required

User information for actors referenced in the notifications

​
paging
object

Pagination information for navigating through results

​
files
object[]

File information for any media referenced in notifications