For Developers

Person

Students, teachers, parents, and administrators are represented within Edlink as People. People do not have a set type or role - instead, they are connected to organizations (e.g., courses) through a set of enrollments.

Properties

PropertyTypeDescription
idUUIDA stable UUID representing this term.
first_nameStringThe user's first name.
middle_nameStringThe user's middle name.
last_nameStringThe user's last name.
display_nameStringThe user's display name.
picture_urlStringA URL for the user's profile picture.
birthdayDateThe user's birthday as an ISO-8601 date.
genderStringThe user's gender.
emailStringThe user's email address.
phoneStringThe user's phone number.
gradesGrade Level ArrayThe user's grade levels.
grade_levelsGrade Level ArrayThe user's grade levels. Identical to grades.
localeStringThe user's language preference.
time_zoneStringThe timezone where the user is located.
sourceSourceMetadata about the source that contains this user's account.