Skip to content

Students

The gym’s student registry — mirrors apps/web’s Students page exactly. health_declaration is LGPD-sensitive personal data (Lei 13.709/2018 art. 5º II); health_declaration_accepted records consent.

List students for the caller’s org.

ArgumentTypeRequiredNotes
limitnumbernodefault 50, max 200
offsetnumbernodefault 0
statusactive | inactive | cancellednofilter

Ordered by full_name ascending.

ArgumentTypeRequired
iduuidyes
ArgumentTypeRequiredNotes
full_namestringyes
phonestringno
cpfstringno
birth_datestringnoYYYY-MM-DD
statusactive | inactive | cancellednodefaults to active
emergency_contact_namestringno
emergency_contact_phonestringno
health_declarationstringnofree text
health_declaration_acceptedbooleannotrue stamps health_declaration_accepted_at now

Same fields as create_student, all optional (partial update), plus id (required). Nullable fields accept null to clear. health_declaration_accepted: false clears the consent timestamp; omit to leave it unchanged.

ArgumentTypeRequired
iduuidyes

Fails if the student still has class_enrollments, check_ins, or contracts rows (no cascading deletes).