API reference
Links
/links
A link says which parents hear about a student. In the High school pack the label reads “linked to” and the contact a primary-only rule writes to is called the “Primary contact”. Links upsert on the pair; there is no unlink through the API.
GETList links
Requires contacts:read. Filter by either side. Returns a bare JSON array.
Query parameters
limitinteger · default 50 · max 200
offsetinteger · default 0
qstring · optional · max 100
Matches either name, the parent's or the student's.
contact_iduuid · optional
All students this parent hears about.
subject_iduuid · optional
All parents linked to this student.
Returns
200 with an array of links. A link has no id of its own: the pair is its identity.
Response body
A bare JSON array. Each item is one link: the same fields in every pack. Press Response on the sample to see one whole.
FieldTypeDescription
tenant_iduuidThe instance.
contact_iduuid
subject_iduuid
relationshipstringA value from the High school pack's relationship_options; filled in by Raven when the pack has only one.Varies by pack
is_primarybooleanExactly one per student.
created_atdatetime
On failure the body is { error, code } instead.