GET https://ed.link/api/v2/graph/enrollments
Retrieve a list of all Enrollments.
Request Parameters
This query allows for standard paging parameters.
| Parameter | Location | Type | Description |
|---|---|---|---|
$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/enrollments', {
headers: {
authorization: `Bearer ${integration_access_token}`
}
});
Sample Response
{
"$data": [
{
"final_letter_grade": null,
"final_numeric_grade": null,
"start_date": "2024-08-15T00:00:00.000Z",
"end_date": "2025-05-30T23:59:59.999Z",
"primary": true,
"created_date": "2024-10-29T16:07:17.460Z",
"updated_date": "2025-01-07T12:28:59.150Z",
"properties": {},
"identifiers": [],
"id": "6b0d2412-f9ad-4aa3-b6ef-e827d8a599e5",
"state": "active",
"role": "teacher",
"person_id": "15c1cc9e-ef7a-4b33-bd65-ffd22df9a4b5",
"class_id": "afc86d45-27ea-481c-8468-1744944757de",
"section_id": null
},
{
"final_letter_grade": null,
"final_numeric_grade": null,
"start_date": "2024-08-15T00:00:00.000Z",
"end_date": "2025-05-30T23:59:59.999Z",
"primary": false,
"created_date": "2024-10-29T16:07:17.460Z",
"updated_date": "2025-01-07T12:28:59.150Z",
"properties": {},
"identifiers": [],
"id": "a3872365-bdaa-46e0-8b5f-4b588cd5bac3",
"state": "active",
"role": "student",
"person_id": "c19bafe2-f7a6-442e-b709-64dd83689566",
"class_id": "fc8ba5f4-1b10-42a8-9929-75790d601912",
"section_id": null
},
{
"final_letter_grade": null,
"final_numeric_grade": null,
"start_date": "2024-11-01T00:00:00.000Z",
"end_date": "2025-03-31T23:59:59.999Z",
"primary": true,
"created_date": "2024-10-29T16:12:27.722Z",
"updated_date": "2025-01-07T12:28:59.150Z",
"properties": {},
"identifiers": [],
"id": "3770f429-0a54-41c5-8c9a-78ba16fa55ee",
"state": "active",
"role": "teacher",
"person_id": "f7ba3e9d-b1f1-451a-802b-f072a3482c55",
"class_id": "fc8ba5f4-1b10-42a8-9929-75790d601912",
"section_id": null
}
],
"$request": "cb32c5a8-96c2-4f0d-8d32-cac38472eead"
}