Get notification

GET

https://app.schoolset.io/app/api/v1/notification/:id

GET

/app/api/v1/notification/:id

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

200Retrieved

1 {
2   "status": "success",
3   "message": "Notification retrieved successfully.",
4   "data": {
5     "id": 12345,
6     "type": {
7       "category": "reminder",
8       "priority": "high"
9     },
10     "method": {
11       "channel": "email",
12       "delivery_time": "2024-06-10T09:00:00Z"
13     },
14     "message": "Your assignment deadline is approaching.",
15     "attributes": {
16       "course": "Mathematics 101",
17       "due_date": "2024-06-15"
18     },
19     "status": "unread",
20     "info": {
21       "sent_by": "prof.jones@schoolset.io",
22       "read_receipt": false
23     },
24     "errors": {},
25     "is_read": false,
26     "is_archive": false,
27     "is_pdf": false,
28     "attachment": null,
29     "created_by": "admin_user",
30     "created_at": "2024-06-01T08:30:00Z",
31     "updated_at": "2024-06-05T12:00:00Z"
32   }
33 }

Returns one notification by identifier.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

Response

Successful GET response for /api/v1/notification/{id}.

statusenum

Allowed values:

messagestring

dataobject