List PTA events for a batch

GET

https://ssuccessv2.com/app/api/v1/pta/events/:batch_id

GET

/app/api/v1/pta/events/:batch_id

$ curl https://ssuccessv2.com/app/api/v1/pta/events/2026 \
>      -H "Authorization: Bearer <token>"

1 {
2   "status": "success",
3   "message": "",
4   "data": [
5     {
6       "id": 1842,
7       "academic_year": {
8         "id": 2026,
9         "name": "2026-2027"
10       },
11       "title": "Fall parent conferences",
12       "start_date": {},
13       "end_date": {},
14       "pta_gap_parent_count": 2,
15       "schedule_type": {
16         "id": 1,
17         "title": "Consecutive"
18       },
19       "slot_duration": {
20         "id": 2,
21         "title": "15 minutes"
22       },
23       "pta_slot_meeting_count": 1,
24       "grades": [],
25       "classes": [],
26       "staff_members": [],
27       "parent_type": "both",
28       "pass_event": false,
29       "exclude_staff_children": false,
30       "created_by": "Taylor Morgan",
31       "created_at": {},
32       "updated_at": {}
33     }
34   ]
35 }

Returns PTA events belonging to the requested batch, including academic year, schedule configuration, target grades/classes/staff, and lifecycle timestamps. The collection is not paginated.

Authentication

AuthorizationBearer

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

Path parameters

batch_idintegerRequired

Academic-year or PTA batch identifier used by the UI.

Response

PTA event collection returned; no matching events are represented by data: [].

statusstring

messagestring

datalist of objects

Errors

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error