SchoolSet APISchool Structure

Load children of a structure node

Returns filtered child nodes for an academic year using optional parent, search, member, and identifier filters.

Authentication

AuthorizationBearer

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

Path parameters

yearIdintegerRequired

Request

This endpoint expects an object.
parent_idstring or nullOptional<=255 characters
searchstring or nullOptional<=100 characters
studentsbooleanOptional
parentsbooleanOptional
staffbooleanOptional
exclude_students_in_year_idinteger or nullOptional>=1
node_idslist of integersOptional
class_idslist of integersOptional

Response

Matching structure children were returned.
statusstringOptional
messagestringOptional
datalist of maps from strings to anyOptional

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error