For Developers
Get Enrollment
GET https://ed.link/api/v2/my/enrollments/:enrollment_id
Retrieve information about a specific Enrollment in which the current user is enrolled.
Request Parameters
Parameter | Type | Description |
---|---|---|
enrollment_id | string | The UUID of the desired Enrollment. |
Sample Request
axios.get('https://ed.link/api/v2/my/enrollments/04c28fa0-c3f5-4320-bb39-4616820e6bc1', {
headers: {
authorization: `Bearer ${integration_access_token}`
}
});
Sample Response
{
"$request": "205364cf-f5e8-41e2-bb18-01bb4f464754",
"$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"
}
],
"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
}
}