For Developers
List Enrollments
GET https://ed.link/api/v2/my/enrollments
Retrieve a list of all Enrollments in which the current user is enrolled.
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/my/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": false,
"created_date": "2024-06-10T20:16:03.959Z",
"updated_date": "2025-04-01T21:09:01.221Z",
"properties": {},
"identifiers": [
{
"type": "canvas_id",
"value": "240"
}
],
"rule_ids": [],
"references": {},
"id": "04c28fa0-c3f5-4320-bb39-4616820e6bc1",
"state": "active",
"role": "teacher",
"person_id": "97f6fe14-78cf-456f-be48-d9f93ab337c6",
"class_id": "2c342faa-92b6-4ba2-87ac-4dbe3e735224",
"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-06-10T20:16:03.959Z",
"updated_date": "2025-04-01T21:09:01.221Z",
"properties": {},
"identifiers": [
{
"type": "canvas_id",
"value": "224"
}
],
"id": "b6df65e2-9d09-4cb0-8955-ff9e68126cc9",
"state": "active",
"role": "teacher",
"person_id": "97f6fe14-78cf-456f-be48-d9f93ab337c6",
"class_id": "961e13e4-560e-4ed0-9a8f-534a03fe759d",
"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-06-10T20:16:03.959Z",
"updated_date": "2025-04-01T21:09:01.221Z",
"properties": {},
"identifiers": [
{
"type": "canvas_id",
"value": "229"
}
],
"id": "3f0b3c17-81c6-461b-ae04-69ce8967e0f3",
"state": "active",
"role": "teacher",
"person_id": "97f6fe14-78cf-456f-be48-d9f93ab337c6",
"class_id": "668b26c5-7a3c-459e-b6e4-10b89bdcb933",
"section_id": null
}
],
"$request": "4093e9c1-0697-43a2-9958-b37e38b23489"
}