For Developers

List Resources

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

Retrieve a list of Resources that belong to a given Module.

Request Parameters

This query allows for paging via the $next parameter.

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

Sample Request

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

Sample Response

{
    "$data": [
        {
            "type": "page",
            "properties": {
                "canvas": {
                    "indent": 0,
                    "position": 1,
                    "published": false,
                    "title": "Page A",
                    "type": "Page"
                }
            },
            "target_id": "00000000-0000-0000-0000-000000000000",
            "module_id": "00000000-0000-0000-0000-000000000000",
            "identifiers": [],
            "rule_ids": [],
            "references": {},
            "id": "00000000-0000-0000-0000-000000000000"
        },
        {
            "type": "custom",
            "properties": {
                "canvas": {
                    "indent": 0,
                    "position": 3,
                    "published": false,
                    "title": "ESPN",
                    "type": "ExternalUrl",
                    "external_url": "https://espn.com"
                }
            },
            "module_id": "00000000-0000-0000-0000-000000000000",
            "identifiers": [],
            "rule_ids": [],
            "references": {},
            "id": "00000000-0000-0000-0000-000000000000"
        },
        {
            "type": "page",
            "properties": {
                "canvas": {
                    "indent": 0,
                    "position": 2,
                    "published": false,
                    "title": "Second Page",
                    "type": "Page"
                }
            },
            "target_id": "00000000-0000-0000-0000-000000000000",
            "module_id": "00000000-0000-0000-0000-000000000000",
            "identifiers": [],
            "rule_ids": [],
            "references": {},
            "id": "00000000-0000-0000-0000-000000000000"
        }
    ],
    "$request": "00000000-0000-0000-0000-000000000000",
    "$warnings": [
        {
            "code": "CUSTOM_RESOURCE_TARGET_ID_NOT_RETURNED",
            "message": "Target IDs for custom resources are not returned."
        }
    ]
}

Supported Providers

  • brightspace
  • canvas
  • google
  • schoology