get_course_folders: Retrieves course folders.

View source: R/get_course_folders.R

get_course_foldersR Documentation

Retrieves course folders.

Description

This function retrieves a list of folders for a specific course in the Canvas LMS API.

Usage

get_course_folders(canvas, course_id, per_page = 100)

Arguments

canvas

An object containing the Canvas API key and base URL, obtained through the canvas_authenticate function.

course_id

The ID of the course for which to retrieve folders.

per_page

Number of courses to retrieve per page. Default is 100.

Details

Returns a list of all folders and sub folders for the given course. Note that for some reported sub folders its main folder may be outside of the course.

Value

A data frame of course folders.

See Also

get_course_root_folder() and get_user_folders()


vvcanvas documentation built on Sept. 9, 2025, 5:39 p.m.