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,
"actionType": "post",
"trayItemCategory": "mention_in_poll",
"targetId": "<string>",
"targetType": "<string>",
"referenceId": "<string>",
"referenceType": "<string>",
"actionReferenceId": "<string>",
"parentId": "<string>",
"data": {
"communityName": "<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"
}
],
"paging": {
"next": "<string>",
"previous": "<string>",
"limit": 123
},
"users": [
{
"_id": "<string>",
"path": "<string>",
"userId": "<string>",
"userInternalId": "<string>",
"userPublicId": "<string>",
"roles": [
"<string>"
],
"permissions": [
"MUTE_CHANNEL"
],
"displayName": "<string>",
"profileHandle": "<string>",
"description": "<string>",
"avatarFileId": "<string>",
"avatarCustomUrl": "<string>",
"flagCount": 123,
"hashFlag": {
"bits": 123,
"hashes": 123,
"hash": [
"<string>"
]
},
"metadata": {},
"isGlobalBan": true,
"isBrand": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"isDeleted": true
}
],
"files": [
{
"fileId": "<string>",
"fileUrl": "<string>",
"type": "image",
"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
}
}
}
]
}
Retrieves the user’s notification tray items, sorted by newest first.
POST api/v4/posts
) but are not real-time.lastSeenAt
time may take up to 30 seconds to reflectcurl --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,
"actionType": "post",
"trayItemCategory": "mention_in_poll",
"targetId": "<string>",
"targetType": "<string>",
"referenceId": "<string>",
"referenceType": "<string>",
"actionReferenceId": "<string>",
"parentId": "<string>",
"data": {
"communityName": "<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"
}
],
"paging": {
"next": "<string>",
"previous": "<string>",
"limit": 123
},
"users": [
{
"_id": "<string>",
"path": "<string>",
"userId": "<string>",
"userInternalId": "<string>",
"userPublicId": "<string>",
"roles": [
"<string>"
],
"permissions": [
"MUTE_CHANNEL"
],
"displayName": "<string>",
"profileHandle": "<string>",
"description": "<string>",
"avatarFileId": "<string>",
"avatarCustomUrl": "<string>",
"flagCount": 123,
"hashFlag": {
"bits": 123,
"hashes": 123,
"hash": [
"<string>"
]
},
"metadata": {},
"isGlobalBan": true,
"isBrand": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"isDeleted": true
}
],
"files": [
{
"fileId": "<string>",
"fileUrl": "<string>",
"type": "image",
"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
}
}
}
]
}
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Pagination options for controlling result set size and navigation
Response containing a list of notification tray items and associated data
The response is of type object
.