API reference

Classes

/groups

A class is who a group-scoped event is about. A static class keeps a list you add to; a dynamic class holds whoever's attributes contain its filter, so nobody keeps it up. Beside the classes somebody keeps are temporary lists, picked by a person for one send: you can see them, but a key cannot change one and an event cannot name one. In the High school pack a class is, for example, “5A”.

GET/groupsList · ?q ?external_ref ?temporary POST/groupsCreate GET/groups/{group_id}Read PATCH/groups/{group_id}Update · attributes replaced whole POST/groups/{group_id}/membersAdd members · up to 500 GET/groups/{group_id}/membersMembers · static DELETE/groups/{group_id}/members/{member_id}Remove a member POST/groups/syncBuild from an attribute GET/groups/{group_id}/matchesMatches · dynamicshown →POST/groups/{group_id}/deactivateDeactivate · no delete

GETList who a class reaches

Requires groups:read. Who a dynamic class holds right now: the active records whose attributes contain its filter — the same answer a send would get. A static class is refused: ask /members.

Path parameters

group_iduuid · required

The class id.

Query parameters

limitinteger · default 50 · max 200

offsetinteger · default 0

Returns

200 with an array of students or parents. 400 on a static class.

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.

Previous← Authentication, keys and scopes NextEvent types →