Get a report-card batch

GET

https://ssuccessv2.com/app/api/v1/report-card/batches/:batch

GET

/app/api/v1/report-card/batches/:batch

$ curl https://ssuccessv2.com/app/api/v1/report-card/batches/42 \
>      -H "Authorization: Bearer <token>"

1 {
2   "status": "success",
3   "message": "",
4   "data": {
5     "id": 42,
6     "name": "Fall Progress Report",
7     "language": "en",
8     "report_card_term_id": 3,
9     "academic_year_id": 2026,
10     "subjects": [
11       {
12         "id": 8,
13         "name": "Mathematics"
14       }
15     ],
16     "nodes": [
17       {
18         "id": 11,
19         "name": "Grade 5",
20         "type": "SchoolGrade"
21       }
22     ],
23     "classes": [
24       {
25         "id": 4,
26         "name": "5A"
27       }
28     ],
29     "class_teachers": [
30       {
31         "teacher_id": 19,
32         "teacher_name": "Alex Morgan",
33         "class_id": 4
34       }
35     ],
36     "grade_teachers": [
37       {
38         "teacher_id": 19,
39         "teacher_name": "Alex Morgan",
40         "grade_id": 11
41       }
42     ],
43     "school_message": "Keep up the great work!",
44     "show_school_name": true,
45     "show_academic_year": true,
46     "general_comments": true,
47     "subject_comments": true,
48     "attendance": true,
49     "attendance_options": {},
50     "report_card_term_name": "Fall Term",
51     "layout": "string",
52     "parent_signature": false,
53     "subjects_count": 6
54   }
55 }

Returns one batch with its selected subjects, school nodes, classes, and teacher assignments.

Authentication

AuthorizationBearer

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

Path parameters

batchintegerRequired

Report-card batch identifier.

Response

Batch details.

statusstring

messagestring

dataobject

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error