For Developers

List Enrollments

GET https://ed.link/api/v2/graph/people/:person_id/enrollments

Retrieve a list of Enrollments associated with the specified Person.

Request Parameters

ParameterTypeDescription
person_idstringThe UUID of the desired Person.

This query allows for standard paging parameters.

This query allows for filtering results.

Sample Request

axios.get('https://ed.link/api/v2/graph/people/00000000-0000-0000-0000-000000000000/enrollments', {
    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": "teacher",
            "primary": null,
            "state": "active",
            "properties": {},
            "person_id": "00000000-0000-0000-0000-000000000000",
            "class_id": "00000000-0000-0000-0000-000000000000",
            "section_id": "00000000-0000-0000-0000-000000000000"
        }
    ],
    "$request": "00000000-0000-0000-0000-000000000000"
}