folders

List Folders

Changed on

List user's accessible folders with hierarchy support

get/folders/

Request

  • Base URL: https://api.excellence-ai.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.excellence-ai.com/folders/
  • Auth: OAuth 2 (password, token URL api/login)

Query parameters

folder_typestring required
parent_folder_idstring nullable

Response

Successful Response

idstring required
namestring required
user_idstring required
parent_folder_idstring nullable
folder_type'teacher_exam' | 'teacher_exercise' | 'teacher_assignment' | 'teacher_course' | 'in_class_activity' | 'student_course' | 'student_assignment' required
is_favorites_rootboolean
shared_class_idstring nullable
school_yearstring nullable
is_pastboolean
created_atstring date-time required
updated_atstring date-time required

Changes

  • 7925dd21e4d0Revision changes
    • warning

      added the new in_class_activity enum value to the / response property for the response status

  • 518c1e6178a3Revision changes
    • info

      added the optional property / to the response with the status