Skip to content
Schoology Dev Docs

Course Folder

A course folder request returns all the contents of the folder with pointers to that piece of content if the API supports it. This includes child Folders. If the folder has a parent, there is a <parent> object that has all the fields of a folder object. Its location attribute will point to the parent. A folder with id = 0 is the root of the course. The contents of the folder is returned in the same order that they are in the course. Ordering does matter.

Fields

Section titled “Fields”
Field Name Description Type
id Schoology ID of the folder content Schoology ID of the folder content integer
title Title The content title string
body Description of the Content If the content has a description or body this is it string
type Type of content Type of content {folder, assignment, discussion, media-album} string
location API endpoint to retrieve content from If the content is accessible via API this location field points to it. string

GET courses/{course_id}/folder/{folder_id}

Section titled “GET courses/{course_id}/folder/{folder_id}”

View the contents of a specific folder

Return A list of objects within the folder

{
  "self": {
    "id": 117703,
    "title": "F8",
    "body": "",
    "available": 1,
    "type": "folder",
    "location": "http:\/\/...",
    "publish_start": "",
    "publish_end": "",
    "status": 1,
    "completion_status": "",
    "has_rules": 0,
    "completed": 0
  },
  "parent": {
    "id": 0,
    "title": "",
    "body": "",
    "available": 1,
    "type": "folder",
    "location": "http:\/\/...",
    "publish_start": "",
    "publish_end": "",
    "status": 0,
    "completion_status": "",
    "has_rules": 0,
    "completed": 0
  },
  "folder-item": [
    {
      "id": 5534077,
      "title": "widget_like_320.zip",
      "body": "",
      "available": 1,
      "completion_status": "",
      "has_rules": 0,
      "completed": 0
    },
    {
      "id": 5534085,
      "title": "Golf Explained - CP Single SCO",
      "body": "",
      "available": 1,
      "type": "package",
      "location": "http:\/\/...",
      "url": "http:\/\/...",
      "completion_status": "",
      "has_rules": 0,
      "completed": 0
    }
  ]
}