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_refshown →POST/subjectsCreateGET/subjects/{subject_id}ReadPATCH/subjects/{subject_id}Update · attributes replaced wholePOST/subjects/{subject_id}/deactivateDeactivate · no delete
GETList students
Requires subjects:read. Returns a bare JSON array, newest first. No envelope, no total; stop when a page comes back shorter than limit.
Query parameters
limitinteger · default 50 · max 200
offsetinteger · default 0
qstring · optional · max 100
Matches display_name, part of a reference and attribute values. It is a search, not a lookup, so it cannot be combined with external_ref.
statusactive | inactive · optional
external_refstring · optional · max 200
Your own id for the student, looked up exactly: an array of one, or an empty one. It is how a system finds the record it created, without keeping a copy of Raven's id. Refused with 400 alongside q: search, or look up.
Returns
200 with an array of students. An empty array when nothing matches.
Response body
A bare JSON array. Each item is 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.