UtilitayDevelopers
Ravenraven
Get an API key
The pack catalogue could not be reached at 18:00 UTC. These pages show the last copy fetched, from 18:00 UTC. Wire names and paths do not change; labels may be behind.
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 ?temporaryPOST/groupsCreateGET/groups/{group_id}ReadPATCH/groups/{group_id}Update · attributes replaced wholePOST/groups/{group_id}/membersAdd members · up to 500GET/groups/{group_id}/membersMembers · staticDELETE/groups/{group_id}/members/{member_id}Remove a memberPOST/groups/syncBuild from an attributeshown →GET/groups/{group_id}/matchesMatches · dynamicPOST/groups/{group_id}/deactivateDeactivate · no delete

POSTBuild classes from a student attribute

Requires groups:write. Makes one dynamic class per value the students hold for the attribute you name — or one per combination, for up to four — and returns them. Safe after every import: what exists is left exactly as it is, and nothing is tidied away.

Body parameters
attributesstring[] · required · max 4
Keys on the student, checked against the pack's subject_schema.
Query parameters
limitinteger · default 50 · max 200
offsetinteger · default 0
Returns

200 with the classes those attributes keep up, made now or before. 400 for a key no student can carry.

Response body

A bare JSON array. Each item is one class: the same fields in every pack. Press Response on the sample to see one whole.

FieldTypeDescription
iduuidWhat an event's group_id names.
namestringUnique in the instance.
kindstatic | dynamicstatic keeps a list; dynamic holds whoever matches its filter.
member_kindsubject | contactWhether it holds students or parents. Fixed when it is made.
filterobject | nullA dynamic group's filter: the student or parent attributes a member's must contain.Varies by pack
derived_fromstring | nullThe subject attribute a group the records keep up was built from. null on a group somebody keeps.
attributesobjectShaped by the High school pack's group_schema.Varies by pack
temporarybooleantrue on a list somebody picked for a send. It cannot be named on an event, and a key cannot change it.
external_refstring | nullYour own id, as you sent it.
statusactive | inactive
created_atdatetime
updated_atdatetime

On failure the body is { error, code } instead.

Previous← Authentication, keys and scopesNextEvent types →