GetStudents | DreamClass

[
  {
    "id": 3,
    "email": "test@test.com",
    "firstname": "Lisa",
    "lastname": "Johnson",
    "middlename": "",
    "address": "123 N St",
    "gender": "",
    "country": "United States",
    "city": "Sacramento",
    "telephone": "123",
    "birthdate": "2013-12-02",
    "birthplace": "Sacramento",
    "customFields": {
      "1": "value1",
      "2": "value2",
      "3": "3"
    },
    "schoolPeriods": [
      {
        "id": 1,
        "active": true,
        "registrationDate": "2023-10-16",
        "schoolPeriod": {
          "id": 1,
          "name": "Dec 2023 - Oct 2024",
          "schoolyear": "",
          "startDate": "2023-12-11",
          "endDate": "2024-10-11",
          "duration": 11
        }
      }
    ],
    "guardians": [
      {
        "guardian": {
          "id": 21,
          "firstname": "John ",
          "lastname": "Johnson ",
          "address": "801, Clement Street",
          "gender": "",
          "country": "United States",
          "city": "San Francisco",
          "telephone": "123456"
        },
        "relation": {
          "id": 1,
          "translation": "RELATION.FATHER",
          "institutionId": 1
        }
      }
    ]
  }
]

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.

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.

Path parameters

nameOrEmailstringRequired

Headers

Response

idinteger

emailstringformat: "email"

firstnamestring

lastnamestring

middlenamestring

addressstring

genderstring

countrystring

citystring

telephonestring

birthdatedate

birthplacestring

customFieldsobject

schoolPeriodslist of objects

guardianslist of objects

mobileanyOptional