For Developers

Schools Overview

An Edlink School represents a single educational institution within a data source, such as a K-12 school or a university campus. There will always be at least one school.

If no schools are present within a data source, we will create a district office placeholder school. For example, Edlink University (District Office). In some cases, this school will be generated to store any classes that are not associated with a school within the data source. In sources like Google Classroom with no concept of schools, a single school will be created to represent the entire data source.

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
namestringThe name of the object.
$filter operators: equals starts with contains in not in is known is unknown
grade_levelsGradeLevel[]The grade levels this school is associated with.
localestringThe locale of the object.
time_zoneTimezoneThe tz database name of the object.
addressAddressThe address location of the object.
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.

JSON Example

{
    "id": "2b610fc6-a2cc-40ac-94e8-f556d451164c",
    "created_date": "2025-07-08T16:04:42.901Z",
    "updated_date": "2025-12-05T14:25:45.920Z",
    "name": "Madison Elementary School",
    "picture_url": null,
    "locale": null,
    "time_zone": "America/Chicago",
    "grade_levels": [
        "KG",
        "01",
        "02",
        "03",
        "04",
        "05"
    ],
    "district_id": "2fcef336-fe50-4475-9909-626cca8114ec",
    "address": {
        "street": "618 Gopher Road",
        "unit": null,
        "postal_code": "97448",
        "city": "Gravity Falls",
        "state": "Oregon",
        "country": "US",
        "phone": "555-555-5555",
        "latitude": null,
        "longitude": null
    },
    "properties": {},
    "identifiers": [
        {
            "type": "qmlativ_id",
            "value": "2"
        }
    ]
}

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✅