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

ParameterTypeDescription
enrollment_idstringThe UUID of the desired Enrollment.

Sample Request

axios.get('https://ed.link/api/v2/my/enrollments/00000000-0000-0000-0000-000000000000', {
    headers: {
        authorization: `Bearer ${integration_access_token}`
    }
});

Sample Response

{
    "$data": {
        "id": "00000000-0000-0000-0000-000000000000",
        "created_date": "2021-07-13T17:45:27.674Z",
        "updated_date": "2021-07-13T17:45:27.674Z",
        "start_date": null,
        "end_date": null,
        "role": "student",
        "primary": null,
        "state": "active",
        "properties": {},
        "person_id": "00000000-0000-0000-0000-000000000000",
        "class_id": "00000000-0000-0000-0000-000000000000",
        "enrollment_id": "00000000-0000-0000-0000-000000000000"
    },
    "$request": "00000000-0000-0000-0000-000000000000"
}