For Developers
List Enrollments
GET https://ed.link/api/v2/graph/classes/:class_id/enrollments
Retrieve a list of Enrollments associated with the specified Class.
Request Parameters
This query allows for standard paging parameters.
Parameter | Location | Type | Description |
---|---|---|---|
class_id | url | string | The UUID of the desired Class. |
$first | query | number | Returns the first n elements from the list. |
$last | query | number | Returns the last n elements from the list. |
$before | query | uuid | Returns the elements in the list that come before the specified item. |
$after | query | uuid | Returns the elements in the list that come after the specified item. |
It is best practice to use either $first
or $last
in conjunction with the $next
value returned by the API to paginate through results.
Read More About Paging
Developer Guide
Click to Read
This query allows for filtering results.
Sample Request
axios.get('https://ed.link/api/v2/graph/classes/c3cd44bc-2a9e-43c9-b32b-71e2b531604b/enrollments', {
headers: {
authorization: `Bearer ${integration_access_token}`
}
});
Sample Response
{
"$data": [
{
"final_letter_grade": null,
"final_numeric_grade": null,
"start_date": "2025-08-05T00:00:00.000Z",
"end_date": "2025-08-06T00:00:00.000Z",
"primary": true,
"created_date": "2025-08-12T04:17:17.942Z",
"updated_date": "2025-08-12T04:17:17.942Z",
"properties": {},
"identifiers": [
{
"type": "sis_id",
"value": "166799"
}
],
"id": "3d4d8c01-d9b2-491e-b906-dcd6e0957ac5",
"state": "dropped",
"role": "student",
"person_id": "d2fd68d7-1cac-4aad-bba9-46fb83bebc52",
"class_id": "c3cd44bc-2a9e-43c9-b32b-71e2b531604b",
"section_id": null
},
{
"final_letter_grade": null,
"final_numeric_grade": null,
"start_date": "2025-08-04T00:00:00.000Z",
"end_date": "2025-12-19T00:00:00.000Z",
"primary": false,
"created_date": "2025-08-12T04:17:17.942Z",
"updated_date": "2025-08-12T04:17:17.942Z",
"properties": {},
"identifiers": [
{
"type": "sis_id",
"value": "36876"
}
],
"id": "df3846d0-1405-4e93-839f-5b26f14711be",
"state": "active",
"role": "teacher",
"person_id": "63acc741-7633-453c-9bfd-75ae1ac34533",
"class_id": "c3cd44bc-2a9e-43c9-b32b-71e2b531604b",
"section_id": null
}
],
"$request": "00000000-0000-0000-0000-000000000000"
}