For Developers

People Overview

A Person within a data source. This model represents an individual (typically a student, teacher, staff member, or parent). It contains demographic information, contact details, and associations with other relevant entities like schools and departments.

People can have more than one role (e.g., a person can be both a student and a teacher).

Note also that not all data sources provide roles at the person level but their enrollments can tell you their role in a class.

Properties

PropertyTypeDescription
idstringThe UUID for the object.
$filter operators: equals in not in
created_dateDateWhen the object was first seen by Edlink.
updated_dateDateWhen the object was last changed in Edlink.
$filter operators: equals gt lt gte lte
first_namestringThe person's first name.
$filter operators: equals starts with contains in not in is known is unknown
middle_namestringThe person's middle name.
last_namestringThe person's last name.
$filter operators: equals starts with contains in not in is known is unknown
display_namestringThe person's display name.
$filter operators: equals starts with contains in not in is known is unknown
picture_urlstringThe URL for the person's profile picture.
rolesRole[]The person's roles. Note that not every data source has roles for a person.
emailstringThe person's email address. Many data sources do not require any sort of email verification for this field, so use caution.
$filter operators: equals starts with contains
phonestringThe person's phone number.
localestringThe locale of the object.
time_zoneTimezoneThe tz database name of the object.
gpanumberThe person's GPA.
letter_gradestringThe person's overall letter grade.
graduation_yearnumberThe person's expected graduation year.
grade_levelsGradeLevel[]The grade levels this person is associated with.
demographicsDemographicsThe person's demographics.
addressAddressThe person's primary address.
propertiesobjectNon-standard properties that may be of interest to the developer.
identifiersIdentifier[]Additional IDs associated with the object.
district_idstringThe UUID of the associated District.
school_idsstring[]The UUIDs of the associated Schools.
department_idsstring[]The UUIDs of the associated Departments.
route_idsstring[]The UUIDs of the associated bus Routes.

JSON Example

{
    "id": "d2fd68d7-1cac-4aad-bba9-46fb83bebc52",
    "created_date": "2024-03-22T17:45:39.937Z",
    "updated_date": "2025-01-15T17:45:39.937Z",
    "first_name": "Dorothy",
    "middle_name": "Melissa",
    "last_name": "Sally",
    "display_name": "Sally D",
    "picture_url": "https://upload.wikimedia.org/wikipedia/en/8/8e/Patrick_Steward_as_Jean-Luc_Picard_in_1996%27s_Star_Trek_First_Contact.jpg",
    "roles": ["student"],
    "email": "sally.d@example.com",
    "phone": null,
    "locale": "en",
    "time_zone": "America/Los_Angeles",
    "graduation_year": 2033,
    "grade_levels": ["05"],
    "demographics": {
        "birthday": null,
        "gender": "female",
        "residence_status": null,
        "english_language_learner": null,
        "country_of_birth": "US",
        "state_of_birth": null,
        "city_of_birth": null,
        "hispanic_or_latino_ethnicity": null,
        "races": ["american-indian-or-alaska-native"],
        "homeless": false,
        "disability": null,
        "gifted_talented": null,
        "food_service_program_eligibility": null,
        "economically_disadvantaged": null,
        "migrant": null,
        "public_assistance": null,
        "rural_residency": null,
        "individualized_education_plan": null,
        "primary_language": null,
        "special_accommodations": null,
        "military_connected": null
    },
    "address": {
        "street": "11314 Prelude Ln",
        "unit": "2",
        "postal_code": "55101",
        "city": "Springfield",
        "state": "OR",
        "country": "US"
    },
    "properties": {},
    "district_id": "792021d3-e334-4c17-b3ab-4f378b7a38ff",
    "school_ids": ["2a745e56-5137-4d13-8b48-23a5d9ae010f"],
    "product_ids": ["6c3618cb-6f1e-4c29-9b17-bed26de68729"],
    "identifiers": [
        {
            "type": "sis_id",
            "value": "231"
        },
        {
            "type": "school_id",
            "value": "8977"
        }
    ]
}

Supported Providers

ProviderSupport
aspen✅
classgather✅
classlink✅
oneroster✅
rapididentity✅
genesis✅
sapphire✅
rediker✅
renweb✅
synergy✅
frontline✅
banner✅
tyler✅
ascender✅
aequitas✅
aeries✅
blackbaud✅
blackboard✅
brightspace✅
canvas✅
clever✅
csv✅
edfi✅
eduplaces✅
facts✅
google✅
illuminate✅
microsoft✅
moodle✅
powerschool✅
schoology✅
bromcom✅
lti✅
skyward✅
veracross✅
qmlativ✅
toddle✅
managebac✅
infinitecampus✅
wonde✅