Notification Poll

GET

http://localhost:3001/v1/notifications/poll

GET

/v1/notifications/poll

1 const url = 'http://localhost:3001/v1/notifications/poll';
2 const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
3 
4 try {
5   const response = await fetch(url, options);
6   const data = await response.json();
7   console.log(data);
8 } catch (error) {
9   console.error(error);
10 }

1 {
2   "notifications": [
3     {
4       "id": "string",
5       "type": "public_broadcast",
6       "sender_name": "string",
7       "recipient_name": "string",
8       "message": "string",
9       "created_at": "string",
10       "from_url": "string"
11     }
12   ],
13   "pagination": {
14     "total": 1.1,
15     "page": 1.1,
16     "limit": 1.1,
17     "totalPages": 1.1
18   },
19   "sidebar": {
20     "manageTicket": {
21       "notifications": [
22         {
23           "id": "string",
24           "message": "string",
25           "notificationIds": [
26             "string"
27           ]
28         }
29       ],
30       "count": 1.1
31     }
32   }
33 }

Poll paginated notifications

Authentication

AuthorizationBearer

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

Query parameters

pageintegerOptional1-100Defaults to 1

limitintegerOptional1-100Defaults to 10

searchstringOptional

Response

Successful response

notificationslist of objects

paginationobject

sidebarobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error