Skip to main content
GET
/
notifications
/
v2
/
rs
List notifications
curl --request GET \
  --url https://z52mnqg347.execute-api.eu-west-3.amazonaws.com/main/notifications/v2/rs \
  --header 'Authorization: Bearer <token>' \
  --header 'content-type: <content-type>' \
  --header 'x-session-token: <x-session-token>'
{
  "data": [
    "<unknown>"
  ],
  "pagination": {
    "limit": 123,
    "offset": 123
  },
  "totalUnreadMessage": 123,
  "totalMessage": 123
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
content-type
string
required

Content type, must be "application/json".

Allowed value: "application/json"
​
x-session-token
string
required

Session token used for authenticating the request.

Example:

"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VySWQiOiIxMjM0NTY3ODkwIiwic2Vzc2lvbklkIjoiYWJjZGVmMTIzNDU2IiwiaWF0IjoxNjA1MDk3ODk5LCJleHAiOjE2MDUxODQyOTl9.4XRQ1iXDyvEj5LgPZHbmTmzOZs98M3YPOzgf3MhxjaI"

Query Parameters

​
includeTotalCountUnread
boolean

Include total count of unread notifications in response

​
includeCount
boolean

Include total count of notifications in response (excluding unread count)

​
limit
number

Maximum number of notifications to return

​
offset
number

Number of notifications to skip

​
category
enum<number>

Filter by notification category

Available options:
1,
2,
3,
4
​
status
enum<number>

Filter by notification status

Available options:
1,
2

Response

200 - application/json

Notifications list retrieved successfully

​
data
any[]
required
​
pagination
object
​
totalUnreadMessage
number
​
totalMessage
number