For Developers

Get Module

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

Retrieve information about a specific Module. As always with the User API, the user whose token you use must actually have access to the class and module in order for this to return successfully.

Request Parameters

ParameterTypeDescription
class_idstringThe UUID of the desired Class.
module_idstringThe UUID of the desired Module.

Sample Request

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

Sample Response

{
    "$data": {
        "title": "My First Module",
        "display_date": null,
        "updated_date": "2025-06-30T15:34:33.670Z",
        "identifiers": [
            {
                "type": "brightspace_id",
                "value": "123"
            }
        ],
        "rule_ids": [],
        "references": {},
        "id": "00000000-0000-0000-0000-000000000000"
    },
    "$request": "00000000-0000-0000-0000-000000000000"
}

Supported Providers

  • blackboard
  • brightspace
  • canvas
  • google
  • microsoft
  • schoology