For Developers

Get Class

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

Retrieve information about the specific Class that the current user is associated with.

Request Parameters

ParameterTypeDescription
class_idstringThe UUID of the desired Class.

Sample Request

axios.get('https://ed.link/api/v2/my/classes/00000000-0000-0000-0000-000000000000', {
    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"
}