Show relatives of students

GET

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

GET

/app/api/v1/relatives

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

200Retrieved

1 {
2   "status": "success",
3   "message": "Relatives records retrieved successfully.",
4   "data": [
5     {
6       "id": 42,
7       "firstname": "Rachel",
8       "lastname": "Levin",
9       "firstname_hebrew": "רחל",
10       "lastname_hebrew": "לוין",
11       "email": "rachel.levin@example.com",
12       "home_phone": "+1-212-555-0198",
13       "cell_phone": "+1-917-555-0123",
14       "address": "123 Maple Street",
15       "city": "Brooklyn",
16       "state": "NY",
17       "country": "USA",
18       "zip": "11201",
19       "user_id": 9876,
20       "verify_sms": true,
21       "family_student_id": 305,
22       "parent_student_type_id": 2,
23       "type": "Mother",
24       "addresses": [
25         {
26           "id": 101,
27           "components": [
28             "123",
29             "Maple Street",
30             "Brooklyn",
31             "NY",
32             "11201",
33             "USA"
34           ],
35           "splitted": [
36             "123",
37             "Maple Street",
38             "Brooklyn",
39             "NY",
40             "11201",
41             "USA"
42           ],
43           "formatted": "123 Maple Street, Brooklyn, NY 11201, USA",
44           "longitude": -73.98513,
45           "latitude": 40.678178,
46           "tag": "home"
47         }
48       ],
49       "created_by": "admin_user",
50       "created_at": "2023-11-15T09:45:00Z",
51       "updated_at": "2024-05-10T14:20:00Z"
52     }
53   ]
54 }

Lists v1 relatives records for the active school context.

Authentication

AuthorizationBearer

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

Response

JSON response payload for the relative collection.

statusenum

Allowed values:

messagestring

datalist of objects