For Developers

List Files

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

Retrieve a list of Files associated with a given Class, visible to the current user. These files represent content items that teachers have made available to students within the class.

Request Parameters

ParameterTypeDescription
class_idstringThe UUID of the desired Class.

This endpoint only supports the $next URL provided in each response to page through results.

Sample Request

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

Sample Response

{
    "$data": [
        {
            "type": "file",
            "title": "mytest.txt",
            "url": "https://ed.link/api/v2/graph/classes/00000000-0000-0000-0000-000000000000/files/00000000-0000-0000-0000-000000000000/download",
            "description": "",
            "size": null,
            "share_mode": "view",
            "identifiers": [
                {
                    "type": "brightspace_id",
                    "value": "mytest.txt"
                }
            ],
            "rule_ids": [],
            "references": {},
            "id": "00000000-0000-0000-0000-000000000000"
        },
        {
            "type": "file",
            "title": "Some Page.html",
            "url": "https://ed.link/api/v2/graph/classes/00000000-0000-0000-0000-000000000000/files/00000000-0000-0000-0000-000000000000/download",
            "description": "",
            "size": null,
            "share_mode": "view",
            "identifiers": [
                {
                    "type": "brightspace_id",
                    "value": "Some Page.html"
                }
            ],
            "rule_ids": [],
            "references": {},
            "id": "00000000-0000-0000-0000-000000000000"
        }
    ],
    "$request": "00000000-0000-0000-0000-000000000000"
}

Supported Providers

  • blackboard
  • brightspace
  • canvas
  • google
  • schoology