For Developers

List Classes

GET https://ed.link/api/v2/my/classes

Retrieve a list of Classes that the current user is enrolled in. A person may be associated with any number of classes, including zero (e.g., if they're an administrators/model).

Request Parameters

This query allows for standard paging parameters.

This query allows for filtering results.

Sample Request

axios.get('https://ed.link/api/v2/my/classes', {
    headers: {
        authorization: `Bearer ${person_access_token}`
    }
});

Sample Response

{
    "$data": [
        {
            "id": "00000000-0000-0000-0000-000000000000",
            "name": "Sample Class",
            "description": null,
            "state": "active",
            "picture_url": null,
            "created_date": "2021-07-13T17:45:27.249Z",
            "updated_date": "2022-01-26T22:44:36.106Z",
            "locale": null,
            "time_zone": null,
            "school_id": "00000000-0000-0000-0000-000000000000",
            "course_id": null,
            "session_ids": [],
            "subjects": [],
            "grade_levels": [],
            "periods": [],
            "properties": {},
            "identifiers": []
        }
    ],
    "$request": "00000000-0000-0000-0000-000000000000"
}