For Developers

Get Enrollment

GET https://ed.link/api/v2/graph/enrollments/:enrollment_id

Retrieve information about a specific Enrollment.

Request Parameters

ParameterTypeDescription
enrollment_idstringThe UUID of the desired Enrollment.

Sample Request

axios.get('https://ed.link/api/v2/graph/enrollments/3770f429-0a54-41c5-8c9a-78ba16fa55ee', {
    headers: {
        authorization: `Bearer ${integration_access_token}`
    }
});

Sample Response

{
    "$data": {
        "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": "de73463e-1b3a-46b9-b0a9-1b3ff1a1217a"
}