Show student information

GET

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

GET

/app/api/v1/student/:id

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

200Retrieved

1 {
2   "status": "success",
3   "message": "Student information retrieved successfully.",
4   "data": {
5     "id": 12345,
6     "firstname": "David",
7     "lastname": "Goldberg",
8     "full_name": "David Goldberg",
9     "full_name_hebrew": "דוד גולדברג",
10     "firstname_hebrew": "דוד",
11     "lastname_hebrew": "גולדברג",
12     "email": "david.goldberg@example.com",
13     "dob": "2008-04-15",
14     "dob_hebrew": "תשס\"ח ניסן ט\"ו",
15     "gender": "male",
16     "phone": "+1-555-123-4567",
17     "photo_file_manager_id": 9876,
18     "addresses": [
19       {
20         "id": 101,
21         "components": [
22           "123 Maple Street",
23           "Apt 4B",
24           "Springfield",
25           "IL",
26           "62704"
27         ],
28         "splitted": [
29           "123 Maple Street",
30           "Apt 4B",
31           "Springfield",
32           "IL",
33           "62704"
34         ],
35         "formatted": "123 Maple Street, Apt 4B, Springfield, IL 62704",
36         "longitude": -89.65,
37         "latitude": 39.7833,
38         "tag": "home"
39       }
40     ],
41     "legal_name": "David Aaron Goldberg",
42     "family_student_id": 54321,
43     "kodesh_name": "David ben Aaron",
44     "gov_id": "A123456789",
45     "medical_note": "Asthma - uses inhaler as needed.",
46     "emergency_contacts": [
47       {
48         "id": 201,
49         "firstname": "Rachel",
50         "lastname": "Goldberg",
51         "emergency_contact_type_id": 2,
52         "home_phone": "+1-555-987-6543",
53         "cell_phone": "+1-555-765-4321",
54         "relation": "Mother",
55         "family_student_id": 54321
56       }
57     ],
58     "medical_info": "No other known medical conditions.",
59     "allergies": "Peanuts",
60     "missing_immunization": false,
61     "required_forms": "Consent form signed on 2023-08-01.",
62     "holy_name_student": "David ben Aaron",
63     "grade": {
64       "id": 5,
65       "name": "5th Grade",
66       "level": 5,
67       "is_active": true
68     },
69     "class": {
70       "id": 12,
71       "name": "5B",
72       "is_active": true,
73       "level": 5
74     },
75     "status": {
76       "id": 3,
77       "title": "Active",
78       "description": "Currently enrolled and attending classes.",
79       "order": 1,
80       "batch_id": 2024
81     },
82     "departments": [
83       {
84         "id": 7,
85         "name": "Science"
86       }
87     ],
88     "staff": [
89       {
90         "id": 88,
91         "firstname": "Sarah",
92         "lastname": "Levin"
93       }
94     ],
95     "academic_year_id": 2023
96   }
97 }

Returns student 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 student.

statusenum

Allowed values:

messagestring

dataobject