{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://raw.githubusercontent.com/api-evangelist/canvas-lms/main/json-schema/canvas-lms-course-schema.json", "title": "Canvas LMS Course", "description": "A Canvas Course as returned by GET /api/v1/courses/{id} and related endpoints. See https://canvas.instructure.com/doc/api/courses.html", "type": "object", "required": ["id", "name", "workflow_state", "account_id", "root_account_id"], "properties": { "id": {"type": "integer", "description": "Numeric Canvas course ID."}, "sis_course_id": {"type": ["string", "null"], "description": "The SIS-side identifier for the course; nil if the course wasn't imported via SIS."}, "uuid": {"type": "string", "description": "Stable cross-shard course UUID."}, "integration_id": {"type": ["string", "null"], "description": "External-system integration identifier."}, "sis_import_id": {"type": ["integer", "null"], "description": "ID of the SIS import that created or updated this course."}, "name": {"type": "string", "description": "Full name of the course."}, "course_code": {"type": "string", "description": "Short code (e.g., 'CS-101')."}, "original_name": {"type": ["string", "null"], "description": "Original course name if a Course Nickname has been set by the user."}, "workflow_state": {"type": "string", "enum": ["unpublished", "available", "completed", "deleted"]}, "account_id": {"type": "integer", "description": "Account that owns this course."}, "root_account_id": {"type": "integer", "description": "The root Canvas account."}, "enrollment_term_id": {"type": "integer", "description": "Term enrollment is tied to."}, "grading_standard_id": {"type": ["integer", "null"]}, "created_at": {"type": "string", "format": "date-time"}, "start_at": {"type": ["string", "null"], "format": "date-time"}, "end_at": {"type": ["string", "null"], "format": "date-time"}, "locale": {"type": ["string", "null"]}, "default_view": {"type": "string", "enum": ["feed", "wiki", "modules", "assignments", "syllabus"]}, "syllabus_body": {"type": ["string", "null"]}, "total_students": {"type": "integer"}, "is_public": {"type": "boolean"}, "is_public_to_auth_users": {"type": "boolean"}, "public_syllabus": {"type": "boolean"}, "public_syllabus_to_auth": {"type": "boolean"}, "storage_quota_mb": {"type": "integer"}, "storage_quota_used_mb": {"type": "number"}, "hide_final_grades": {"type": "boolean"}, "license": {"type": ["string", "null"]}, "allow_student_assignment_edits": {"type": "boolean"}, "allow_wiki_comments": {"type": "boolean"}, "allow_student_forum_attachments": {"type": "boolean"}, "open_enrollment": {"type": "boolean"}, "self_enrollment": {"type": "boolean"}, "restrict_enrollments_to_course_dates": {"type": "boolean"}, "course_format": {"type": ["string", "null"]}, "time_zone": {"type": "string"}, "blueprint": {"type": "boolean"}, "template": {"type": "boolean"}, "homeroom_course": {"type": "boolean"} } }