List notes for students in a family

GET

https://ssuccessv2.com/app/api/v1/family/:id/notes

GET

/app/api/v1/family/:id/notes

$ curl -G https://ssuccessv2.com/app/api/v1/family/1842/notes \
>      -H "Authorization: Bearer <token>" \
>      -d batch_id=2026

1 {
2   "status": "success",
3   "message": "",
4   "data": [
5     {
6       "id": 610,
7       "title": "Asthma action plan",
8       "note": "Updated inhaler instructions received.",
9       "draft": false,
10       "favorite": true,
11       "students": [
12         {
13           "id": 2987,
14           "firstname": "Mateo",
15           "lastname": "Garcia"
16         }
17       ],
18       "academic_year": {
19         "id": 2026,
20         "name": "2026-2027"
21       },
22       "type": {
23         "title": "Medical"
24       },
25       "status": {
26         "title": "Active"
27       },
28       "created_by": "Office Admin",
29       "attachments": [],
30       "categories": [],
31       "school_grades": [],
32       "school_classes": [],
33       "folders": [],
34       "contributors": [],
35       "created_at": "2024-01-15T09:30:00Z",
36       "updated_at": "2024-01-15T09:30:00Z"
37     }
38   ]
39 }

Returns notes belonging to students in the family. Use batch_id to restrict notes to one academic year.

Authentication

AuthorizationBearer

The signed-in SchoolSet user token sent by the frontend.

Path parameters

idintegerRequired>=1

Query parameters

batch_idintegerOptional>=1

Response

Notes returned.

statusstringOptional

messagestringOptional

datalist of objectsOptional

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error