Classes Overview

By Jaron Pate

Last Updated October 8th, 2025

A Class is an instance of a Course. Many People can be Enrolled in a Class.

Classes typically define a specific time period (e.g., semester, quarter) during which the course is taught.

In previous versions of the Edlink API, this concept was called a Course. Please review Migration from v1.0 for more information.

In v2.0, we've corrected some of our terminology to be more accurate and universal.

Properties

Property	Type	Description
`id`	`string`	The UUID for the object. $filter operators: `equals` `in` `not in`
`created_date`	`Date`	When the object was first seen by Edlink.
`updated_date`	`Date`	When the object was last changed in Edlink. $filter operators: `equals` `gt` `lt` `gte` `lte`
`name`	`string`, `null`	The name of the object. $filter operators: `equals` `starts with` `contains` `in` `not in` `is known` `is unknown`
`description`	`string`, `null`	The description of the object.
`picture_url`	`string`, `null`	The URL for the class' profile picture.
`subjects`	`Subject[]`	DEPRECATED: The subjects this class is associated with. These are provided as plaintext and are not necessarily associated with the new `subject_id` property below.
`grade_levels`	`GradeLevel[]`	The grade levels this class is associated with.
`periods`	`string[]`	DEPRECATED: The periods this class is taught. These are provided as plaintext and are not necessarily associated with the new `period_ids` property below.
`state`	`Class State`	The state of the class. $filter operators: `equals` `in` `not in`
`locale`	`string`, `null`	The locale of the object.
`time_zone`	`Timezone`, `null`	The tz database name of the object.
`properties`	`object`	Non-standard properties that may be of interest to the developer.
`identifiers`	`Identifier[]`	Additional IDs associated with the object.
`session_ids`	`string[]`	The UUIDs of the associated Sessions. $filter operators: `equals` `in` `not in`
`course_id`	`string`, `null`	The UUID of the associated Course. $filter operators: `equals` `in` `not in`
`school_id`	`string`	The UUID of the associated School.
`department_id`	`string`, `null`	The UUID of the associated Department. $filter operators: `equals` `in` `not in`
`subject_id`	`string`, `null`	The UUID of the associated Subject. $filter operators: `equals` `in` `not in`
`period_ids`	`string[]`	The UUIDs of the associated Periods. $filter operators: `equals` `in` `not in`
`room_ids`	`string[]`	The UUIDs of the associated Rooms. $filter operators: `equals` `in` `not in`
`product_ids`	`string[]`	The UUIDs of the associated Products.

Notes

The subjects and periods properties have been deprecated in favor of the new Subject and Period models.
- The old properties will still be supported through the lifespan of API V2, but they may not be as accurate as the new models.
The new subject_id property is singular.
When you use the $expand operator on periods, the result will override the deprecated periods property.

JSON Example

{
    "id": "c3cd44bc-2a9e-43c9-b32b-71e2b531604b",
    "created_date": "2021-07-13T17:45:27.685Z",
    "updated_date": "2021-07-13T17:45:27.685Z",
    "name": "Defense Against the Dark Arts",
    "description": "Learn how to protect yourself against the dark arts.",
    "picture_url": "https://static.wikia.nocookie.net/harrypotter/images/2/2c/Harry-potter2-lockhart_professor.jpg",
    "grade_levels": ["06"],
    "subjects": ["CEDS.08"],
    "periods": ["1"],
    "state": "active",
    "locale": null,
    "time_zone": "Europe/London",
    "properties": {},
    "session_ids": ["dec40712-9e51-4133-b5e0-e7ec3e3c1041"],
    "course_id": "5e9683a1-e515-40d8-9d45-ee2036b3ed7e",
    "school_id": "f507d94a-c6c7-4442-8d08-c205b9b232ae",
    "department_id": "7326b372-8383-4788-8bed-4def36ee608a",
    "subject_id": "17844f50-9fcd-4104-a94f-13c809518393",
    "period_ids": ["500a57e3-2e3e-451a-8a76-9d59a85f42c8"],
    "room_ids": ["0ac9d989-4df9-4d5c-a2cd-5c071474de29"],
    "product_ids": ["6c3618cb-6f1e-4c29-9b17-bed26de68729", "9db1de04-686b-4b59-b8ce-15bfcb757c60", "de8f4e41-c64c-4fe8-bcba-d74e1351d6d5"],
    "identifiers": [
        {
            "type": "sis_id",
            "value": "DADA2021"
        }
    ]
}

Supported Providers

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