List notifications

GET

https://app.schoolset.io/app/api/v1/notifications

GET

/app/api/v1/notifications

1 curl https://app.schoolset.io/app/api/v1/notifications \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json"

200Retrieved

1 {
2   "status": "success",
3   "message": "Notifications retrieved successfully.",
4   "data": [
5     {
6       "id": 1024,
7       "type": {
8         "category": "reminder",
9         "priority": "high"
10       },
11       "method": {
12         "channel": "email",
13         "delivery_time": "immediate"
14       },
15       "message": "Your assignment deadline is tomorrow at 5 PM.",
16       "attributes": {
17         "subject": "Math Homework",
18         "due_date": "2024-06-15T17:00:00Z"
19       },
20       "status": "unread",
21       "info": {
22         "class": "10B",
23         "teacher": "Mr. Smith"
24       },
25       "errors": {},
26       "is_read": false,
27       "is_archive": false,
28       "is_pdf": false,
29       "attachment": null,
30       "created_by": "admin@schoolset.io",
31       "created_at": "2024-06-14T08:30:00Z",
32       "updated_at": "2024-06-14T08:30:00Z"
33     }
34   ]
35 }

Returns notifications visible to the current user.

Authentication

AuthorizationBearer

You can retrieve your token by visiting your dashboard and clicking Generate API token.

Response

Successful GET response for /api/v1/notifications.

statusenum

Allowed values:

messagestring

datalist of objects