Skip to navigation

GetStudents

View as Markdown

Get a list of students, matched on last name or email address.

Input variables

  • nameOrEmail: string to match against the last name or the email of the student(s). Optional - omit the whole path segment to list every student record.

Only students of the school named by your schoolCode are returned. On an account with several schools, each school’s key lists its own students.

School periods and tags

schoolPeriods lists every school period the student is enrolled in. Each entry’s id is the student’s enrollment in that period (the periodStudentId on invoice fee lines, and id in GetPeriodStudents).

Tags are given to a student per school period, so they sit on each period rather than on the student: schoolPeriods[].schoolTags. A student tagged last year but not this year shows the tag only on last year’s period. Each tag carries:

  • id, name, color
  • entityType — the kind of tag; STUDENT_TO_SEMESTER for student tags
  • parentSchoolTagId — the tag group it belongs to, or null

The full list of your school’s tags is returned by Settings > Tags.

Path parameters

nameOrEmailstringRequired

Headers

dreamclass-secret-keystringOptional

Your DreamClass API key. Required on every request. Find it in the DreamClass app under Settings > Integrations.

tenantstringOptional

Your tenant code: the DreamClass subdomain you sign in at (for https://myaccount.dreamclass.io it is “myaccount”), or your full white-labelled domain. Required on every request.

schoolCodestringOptional

Your school code. Required on every request. Find it in the DreamClass app under Settings > Integrations.

Response

OK
idinteger
emailstringformat: "email"
firstnamestring
lastnamestring
middlenamestring
addressstring
genderstring
countrystring
citystring
telephonestring
birthdatedate
birthplacestring
customFieldsobject
schoolPeriodslist of objects
guardianslist of objects
mobileanyOptional