API reference
Students
/subjects
A student is what events are about. Parents are linked to students through /links. In the High school pack a student is, for example, “Musu Kollie” with reference STU-2026-001.
GET/subjectsList · ?q ?external_refPOST/subjectsCreateshown →GET/subjects/{subject_id}ReadPATCH/subjects/{subject_id}Update · attributes replaced wholePOST/subjects/{subject_id}/deactivateDeactivate · no delete
POSTCreate a student
Requires subjects:write. Unknown keys inside attributes are refused with 400: schemas are closed. There is no class field here; classes that follow an attribute are kept in step by Raven.
Body parameters
display_namestring · required · max 200
“Musu Kollie”.
external_refstring · optional · max 200
Your own identifier. “STU-2026-001”. Trimmed as it is stored, and it is what ?external_ref= looks up exactly.
attributesobject · optionalVaries by pack
Generated from the High school pack's subject_schema. PATCH replaces the whole object; it does not merge.
KeyLabelKindAllowed valuesRequired
yearYear grouptext—No
classClasstext—No
Returns
201 with the student. 400 for a bad or unknown attribute; the sentence names it. 409 if the reference is already on file — “That reference is already used by another record. Find it with ?external_ref= and update that record instead.”
Response body
One student: the same fields in every pack. Press Response on the sample to see one whole.
FieldTypeDescription
iduuid
tenant_iduuidThe instance.
external_refstring | nullYour own id, as you sent it.
display_namestring
attributesobjectShaped by the High school pack's subject_schema.Varies by pack
statusactive | inactive
created_atdatetime
updated_atdatetime
On failure the body is { error, code } instead.