Show relative of student

GET

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

GET

/app/api/v1/relative/:id

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

200Retrieved

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

Returns v1 relative information for the selected context.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

Response

JSON response payload for a single relative.

statusenum

Allowed values:

messagestring

dataobject