generated: '2026-09-05'
method: derived
source: openapi/canvas-lms-openapi.yml (components.schemas $ref links and *_id reference fields)
note: Derived mechanically. Instructure publishes no ERD for the REST API — the object shapes are declared per resource
  in the Swagger 1.2 models and nowhere joined up. Twelve model names collide across resources with different shapes
  (Account, File, Grade, Module, ModuleItem, OutcomeAlignment, Progress, Report, ReportParameters, Result, RubricRating,
  Submission); those are namespaced <Name>__<resource> in the converted spec and folded back to the bare name here.
summary:
  entities: 283
  relationships: 168
  id_scheme: 64-bit integers; most id path segments also accept a qualified SIS id (sis_course_id:, sis_user_id:,
    …)
  sis_id_docs: https://developerdocs.instructure.com/services/canvas/basics/file.object_ids
core_entities:
- Account
- Course
- Section
- User
- Enrollment
- Assignment
- Submission
- Quiz
- Module
- Page
- DiscussionTopic
- File
- Folder
- Group
- Rubric
- Outcome
- Term
- Progress
entities:
- entity: AccessibilityCourseStatistic
  schema: AccessibilityCourseStatistic
  field_count: 11
  description: Per-course accessibility issue counts for a user's active teacher/designer courses.
- entity: AccommodationResponse
  schema: AccommodationResponse
  field_count: 3
  description: Response structure for processing accommodations
- entity: AccountCalendar
  schema: AccountCalendar
  field_count: 13
- entity: AccountNotification
  schema: AccountNotification
  field_count: 8
- entity: Account
  schema: Account__accounts
  field_count: 17
- entity: Account
  schema: Account__accounts_(lti)
  field_count: 6
- entity: Admin
  schema: Admin
  field_count: 4
- entity: AiExperience
  schema: AiExperience
  field_count: 8
  description: An AI Experience for interactive learning
- entity: AnonymousUserDisplay
  schema: AnonymousUserDisplay
  field_count: 3
  description: This mini-object is returned in place of UserDisplay when returning student data for anonymous assignments,
    and includes an anonymous ID to identify a user within the scope of a single assignment.
- entity: Answer
  schema: Answer
  field_count: 16
- entity: Appointment
  schema: Appointment
  field_count: 3
  description: Date and time for an appointment
- entity: AppointmentGroup
  schema: AppointmentGroup
  field_count: 26
- entity: Assessment
  schema: Assessment
  field_count: 3
  description: A simple assessment that collects pass/fail results for a student
- entity: AssessmentQuestion
  schema: AssessmentQuestion
  field_count: 21
- entity: AssessmentQuestionBank
  schema: AssessmentQuestionBank
  field_count: 9
- entity: Assignment
  schema: Assignment
  field_count: 89
- entity: AssignmentDate
  schema: AssignmentDate
  field_count: 6
  description: Object representing a due date for an assignment or quiz. If the due date came from an assignment
    override, it will have an 'id' field.
- entity: AssignmentEvent
  schema: AssignmentEvent
  field_count: 19
- entity: AssignmentExtension
  schema: AssignmentExtension
  field_count: 3
- entity: AssignmentGroup
  schema: AssignmentGroup
  field_count: 8
- entity: AssignmentGroupAttributes
  schema: AssignmentGroupAttributes
  field_count: 5
  description: Some of the attributes of an Assignment Group. See Assignments API for more details
- entity: AssignmentGroupGrade
  schema: AssignmentGroupGrade
  field_count: 7
- entity: AssignmentOverride
  schema: AssignmentOverride
  field_count: 16
- entity: AsyncApiErrorResponse
  schema: AsyncApiErrorResponse
  field_count: 1
  description: Error response structure returned by the API when validation or processing failures occur
- entity: AsyncQueryResponse
  schema: AsyncQueryResponse
  field_count: 1
  description: Response returned when successfully initiating a page views query
- entity: AsyncQueryResultsResponse
  schema: AsyncQueryResultsResponse
  field_count: 4
  description: File download response containing page views query results
- entity: AsyncQueryStatusResponse
  schema: AsyncQueryStatusResponse
  field_count: 5
  description: Response containing the current status of a page views query
- entity: AuthenticationEvent
  schema: AuthenticationEvent
  field_count: 5
- entity: AuthenticationProvider
  schema: AuthenticationProvider
  field_count: 20
- entity: Avatar
  schema: Avatar
  field_count: 8
  description: Possible avatar for a user.
- entity: BankEntryItem
  schema: BankEntryItem
  field_count: 7
- entity: BankItem
  schema: BankItem
  field_count: 5
- entity: BasicUser
  schema: BasicUser
  field_count: 2
- entity: BlackoutDate
  schema: BlackoutDate
  field_count: 6
  description: Blackout dates are used to prevent scheduling assignments on a given date in course pacing.
- entity: BlockEditorTemplate
  schema: BlockEditorTemplate
  field_count: 9
- entity: BlueprintMigration
  schema: BlueprintMigration
  field_count: 10
- entity: BlueprintRestriction
  schema: BlueprintRestriction
  field_count: 4
  description: A set of restrictions on editing for copied objects in associated courses
- entity: BlueprintSubscription
  schema: BlueprintSubscription
  field_count: 3
  description: Associates a course with a blueprint
- entity: BlueprintTemplate
  schema: BlueprintTemplate
  field_count: 5
- entity: Bookmark
  schema: Bookmark
  field_count: 5
- entity: CalendarEvent
  schema: CalendarEvent
  field_count: 38
- entity: CalendarLink
  schema: CalendarLink
  field_count: 1
- entity: CareerUserContext
  schema: CareerUserContext
  field_count: 8
- entity: ChangeRecord
  schema: ChangeRecord
  field_count: 7
  description: Describes a learning object change propagated to associated courses from a blueprint course
- entity: Collaboration
  schema: Collaboration
  field_count: 14
- entity: Collaborator
  schema: Collaborator
  field_count: 3
- entity: ColumnDatum
  schema: ColumnDatum
  field_count: 2
  description: ColumnDatum objects contain the entry for a column for each user.
- entity: CommMessage
  schema: CommMessage
  field_count: 11
- entity: CommunicationChannel
  schema: CommunicationChannel
  field_count: 8
- entity: CompletionRequirement
  schema: CompletionRequirement
  field_count: 4
- entity: Conference
  schema: Conference
  field_count: 19
- entity: ConferenceRecording
  schema: ConferenceRecording
  field_count: 5
- entity: ContentDetails
  schema: ContentDetails
  field_count: 7
- entity: ContentExport
  schema: ContentExport
  field_count: 7
- entity: ContentMigration
  schema: ContentMigration
  field_count: 11
- entity: ContentShare
  schema: ContentShare
  field_count: 11
  description: Content shared between users
- entity: ContextExternalTool
  schema: ContextExternalTool
  field_count: 70
  description: An external tool configured for a specific context
- entity: ContextExternalToolMessageSettings
  schema: ContextExternalToolMessageSettings
  field_count: 4
  description: Configuration for a placementless message type (message type that doesn't belong to a specific placement)
- entity: ContextExternalToolPlacement
  schema: ContextExternalToolPlacement
  field_count: 28
  description: Configuration for a specific placement of an external tool. If null, no configuration is present.
- entity: ContextSearchResponse
  schema: ContextSearchResponse
  field_count: 2
  description: The response for the Search Accounts and Courses API endpoint
- entity: Conversation
  schema: Conversation
  field_count: 16
- entity: ConversationParticipant
  schema: ConversationParticipant
  field_count: 5
- entity: Course
  schema: Course
  field_count: 51
- entity: CourseAccommodationRequest
  schema: CourseAccommodationRequest
  field_count: 4
  description: Request format for setting course-level accommodations
- entity: CourseAttributes
  schema: CourseAttributes
  field_count: 4
  description: Attributes of a course object.  See Courses API for more details
- entity: CourseEpubExport
  schema: CourseEpubExport
  field_count: 3
  description: Combination of a Course & EpubExport.
- entity: CourseEvent
  schema: CourseEvent
  field_count: 6
- entity: CourseEventLink
  schema: CourseEventLink
  field_count: 6
- entity: CourseNickname
  schema: CourseNickname
  field_count: 3
- entity: CoursePace
  schema: CoursePace
  field_count: 15
- entity: CourseProgress
  schema: CourseProgress
  field_count: 4
- entity: CourseQuizExtension
  schema: CourseQuizExtension
  field_count: 5
- entity: CreatedEventData
  schema: CreatedEventData
  field_count: 5
  description: 'The created event data object returns all the fields that were set in the format of the following
    example.  If a field does not exist it was not set. The value of each field changed is in the format of [:old_value,
    :new_value].  The created event type also includes a created_source field to specify '
- entity: CustomColumn
  schema: CustomColumn
  field_count: 6
- entity: Day
  schema: Day
  field_count: 2
- entity: DeveloperKey
  schema: DeveloperKey
  field_count: 34
  description: a Canvas API key (or LTI 1.3 registration)
- entity: DeveloperKeyAccountBinding
  schema: DeveloperKeyAccountBinding
  field_count: 5
- entity: DiscoveryPage
  schema: DiscoveryPage
  field_count: 3
  description: Configuration for the login discovery page
- entity: DiscoveryPageEntry
  schema: DiscoveryPageEntry
  field_count: 3
  description: A single authentication provider entry on the discovery page
- entity: DiscussionTopic
  schema: DiscussionTopic
  field_count: 38
  description: A discussion topic
- entity: Enrollment
  schema: Enrollment
  field_count: 44
- entity: EnrollmentTerm
  schema: EnrollmentTerm
  field_count: 9
- entity: EnrollmentTermsList
  schema: EnrollmentTermsList
  field_count: 1
- entity: EpubExport
  schema: EpubExport
  field_count: 6
- entity: ErrorReport
  schema: ErrorReport
  field_count: 7
  description: A collection of information around a specific notification of a problem
- entity: EstimatedDuration
  schema: EstimatedDuration
  field_count: 4
  description: An estimated duration for completing a learning activity
- entity: ExceptionRecord
  schema: ExceptionRecord
  field_count: 2
  description: Lists associated courses that did not receive a change propagated from a blueprint
- entity: ExperienceSummary
  schema: ExperienceSummary
  field_count: 2
- entity: ExternalFeed
  schema: ExternalFeed
  field_count: 6
- entity: ExternalToolTagAttributes
  schema: ExternalToolTagAttributes
  field_count: 3
- entity: Favorite
  schema: Favorite
  field_count: 2
- entity: Feature
  schema: Feature
  field_count: 9
- entity: FeatureFlag
  schema: FeatureFlag
  field_count: 5
- entity: FederatedAttributeConfig
  schema: FederatedAttributeConfig
  field_count: 3
  description: A single attribute name to be federated when a user logs in
- entity: FederatedAttributesConfig
  schema: FederatedAttributesConfig
  field_count: 11
  description: 'A mapping of Canvas attribute names to attribute names that a provider may send, in order to update
    the value of these attributes when a user logs in. The values can be a FederatedAttributeConfig, or a raw string
    corresponding to the "attribute" property of a FederatedAttributeConfig. In responses, '
- entity: FileAttachment
  schema: FileAttachment
  field_count: 4
  description: A file attachment
- entity: File
  schema: File__files
  field_count: 23
- entity: File
  schema: File__plagiarism_detection_submissions
  field_count: 7
- entity: Folder
  schema: Folder
  field_count: 20
- entity: GradeChangeEvent
  schema: GradeChangeEvent
  field_count: 11
- entity: GradeChangeEventLinks
  schema: GradeChangeEventLinks
  field_count: 5
- entity: GradeGroup
  schema: GradeGroup
  field_count: 1
- entity: Grade
  schema: Grade__enrollments
  field_count: 11
- entity: Grade
  schema: Grade__what_if_grades
  field_count: 4
- entity: Grader
  schema: Grader
  field_count: 3
- entity: Grades
  schema: Grades
  field_count: 4
- entity: GradingPeriod
  schema: GradingPeriod
  field_count: 7
- entity: GradingPeriodSets
  schema: GradingPeriodSets
  field_count: 3
- entity: GradingRules
  schema: GradingRules
  field_count: 3
- entity: GradingSchemeEntry
  schema: GradingSchemeEntry
  field_count: 3
- entity: GradingStandard
  schema: GradingStandard
  field_count: 7
- entity: Group
  schema: Group
  field_count: 20
- entity: GroupCategory
  schema: GroupCategory
  field_count: 12
- entity: GroupMembership
  schema: GroupMembership
  field_count: 7
- entity: HelpLink
  schema: HelpLink
  field_count: 6
- entity: HelpLinks
  schema: HelpLinks
  field_count: 4
- entity: HistoryEntry
  schema: HistoryEntry
  field_count: 10
  description: Information about a recently visited item or page in Canvas
- entity: InstAccessToken
  schema: InstAccessToken
  field_count: 1
- entity: ItemProperties
  schema: ItemProperties
  field_count: 1
- entity: JSONAPIPagination
  schema: JSONAPIPagination
  field_count: 0
- entity: JWT
  schema: JWT
  field_count: 1
- entity: LatePolicy
  schema: LatePolicy
  field_count: 11
- entity: LearningObjectDates
  schema: LearningObjectDates
  field_count: 14
- entity: License
  schema: License
  field_count: 3
- entity: LineItem
  schema: LineItem
  field_count: 8
- entity: ListLtiRegistrationsResponse
  schema: ListLtiRegistrationsResponse
  field_count: 2
  description: The response for the List LTI Registrations API endpoint
- entity: LockInfo
  schema: LockInfo
  field_count: 5
- entity: Lti::ContextControl
  schema: Lti::ContextControl
  field_count: 17
  description: Represent availability of an LTI registration in a specific context
- entity: Lti::LaunchDefinition
  schema: Lti::LaunchDefinition
  field_count: 8
  description: A bare-bones representation of an LTI tool used by Canvas to launch the tool
- entity: Lti::LaunchSettings
  schema: Lti::LaunchSettings
  field_count: 22
  description: Default launch settings for all placements
- entity: Lti::LegacyConfiguration
  schema: Lti::LegacyConfiguration
  field_count: 10
  description: A legacy configuration format for LTI 1.3 tools.
- entity: Lti::Overlay
  schema: Lti::Overlay
  field_count: 10
  description: Changes made by a Canvas admin to a tool's configuration.
- entity: Lti::OverlayVersion
  schema: Lti::OverlayVersion
  field_count: 8
  description: A single version of a tool's configuration overlay
- entity: Lti::Placement
  schema: Lti::Placement
  field_count: 24
  description: The tool's configuration for a specific placement
- entity: Lti::PlacementLaunchDefinition
  schema: Lti::PlacementLaunchDefinition
  field_count: 3
  description: A bare-bones LTI configuration for a specific placement
- entity: Lti::PlacementOverlay
  schema: Lti::PlacementOverlay
  field_count: 7
  description: Changes made by a Canvas admin to a tool's configuration for a specific placement.
- entity: Lti::Registration
  schema: Lti::Registration
  field_count: 20
  description: A registration of an LTI tool in Canvas
- entity: Lti::RegistrationAccountBinding
  schema: Lti::RegistrationAccountBinding
  field_count: 9
  description: A binding between an LTI registration and an account, defining the registration's availability in
    that account
- entity: Lti::ResourceLink
  schema: Lti::ResourceLink
  field_count: 16
- entity: Lti::ToolConfiguration
  schema: Lti::ToolConfiguration
  field_count: 15
  description: A Registration's Canvas-specific tool configuration.
- entity: LtiAssignment
  schema: LtiAssignment
  field_count: 8
  description: A Canvas assignment
- entity: MediaComment
  schema: MediaComment
  field_count: 5
- entity: MediaObject
  schema: MediaObject
  field_count: 7
- entity: MediaTrack
  schema: MediaTrack
  field_count: 9
- entity: MigrationIssue
  schema: MigrationIssue
  field_count: 10
- entity: Migrator
  schema: Migrator
  field_count: 4
- entity: ModuleAssignmentOverride
  schema: ModuleAssignmentOverride
  field_count: 5
- entity: ModuleItemSequence
  schema: ModuleItemSequence
  field_count: 2
- entity: ModuleItemSequenceNode
  schema: ModuleItemSequenceNode
  field_count: 4
- entity: ModuleItem
  schema: ModuleItem__course_pace
  field_count: 11
- entity: ModuleItem
  schema: ModuleItem__modules
  field_count: 15
- entity: Module
  schema: Module__course_pace
  field_count: 6
- entity: Module
  schema: Module__modules
  field_count: 15
- entity: MultipleAttemptsSettings
  schema: MultipleAttemptsSettings
  field_count: 6
- entity: NamesAndRoleContext
  schema: NamesAndRoleContext
  field_count: 3
  description: An abbreviated representation of an LTI Context
- entity: NamesAndRoleMembership
  schema: NamesAndRoleMembership
  field_count: 10
  description: A member of a LTI Context in one or more roles
- entity: NamesAndRoleMemberships
  schema: NamesAndRoleMemberships
  field_count: 3
- entity: NamesAndRoleMessage
  schema: NamesAndRoleMessage
  field_count: 5
  description: Additional attributes which would appear in the LTI launch message were this member to click the
    specified resource link (`rlid` query parameter)
- entity: NeedsGradingCount
  schema: NeedsGradingCount
  field_count: 2
  description: Used by Assignment model
- entity: NewQuiz
  schema: NewQuiz
  field_count: 11
- entity: NoticeCatalog
  schema: NoticeCatalog
  field_count: 3
  description: Set of notice handlers (one per notice type) for an LTI tool deployment.
- entity: NoticeHandler
  schema: NoticeHandler
  field_count: 3
  description: A notice handler for a particular tool deployment and notice type.
- entity: NotificationPreference
  schema: NotificationPreference
  field_count: 4
- entity: OriginalityReport
  schema: OriginalityReport
  field_count: 9
- entity: Outcome
  schema: Outcome
  field_count: 17
- entity: OutcomeAlignment
  schema: OutcomeAlignment__outcome_results
  field_count: 3
  description: An asset aligned with this outcome
- entity: OutcomeAlignment
  schema: OutcomeAlignment__outcomes
  field_count: 6
- entity: OutcomeGroup
  schema: OutcomeGroup
  field_count: 12
- entity: OutcomeImport
  schema: OutcomeImport
  field_count: 10
- entity: OutcomeImportData
  schema: OutcomeImportData
  field_count: 1
- entity: OutcomeLink
  schema: OutcomeLink
  field_count: 7
- entity: OutcomePath
  schema: OutcomePath
  field_count: 2
  description: The full path to an outcome
- entity: OutcomePathPart
  schema: OutcomePathPart
  field_count: 1
  description: An outcome or outcome group
- entity: OutcomeResult
  schema: OutcomeResult
  field_count: 5
  description: A student's result for an outcome
- entity: OutcomeRollup
  schema: OutcomeRollup
  field_count: 3
- entity: OutcomeRollupLinks
  schema: OutcomeRollupLinks
  field_count: 3
- entity: OutcomeRollupScore
  schema: OutcomeRollupScore
  field_count: 3
- entity: OutcomeRollupScoreLinks
  schema: OutcomeRollupScoreLinks
  field_count: 1
- entity: OverrideTarget
  schema: OverrideTarget
  field_count: 2
- entity: Page
  schema: Page
  field_count: 17
- entity: PageRevision
  schema: PageRevision
  field_count: 7
- entity: PageView
  schema: PageView
  field_count: 20
  description: The record of a user page view access in Canvas
- entity: PageViewLinks
  schema: PageViewLinks
  field_count: 5
  description: The links of a page view access in Canvas
- entity: PairingCode
  schema: PairingCode
  field_count: 4
  description: A code used for linking a user to a student to observe them.
- entity: PeerReview
  schema: PeerReview
  field_count: 9
- entity: Permission
  schema: Permission
  field_count: 6
  description: A permission that can be granted to a role
- entity: PermissionHelpText
  schema: PermissionHelpText
  field_count: 2
  description: Information about a permission, including its purpose and considerations for use.
- entity: PlannerNote
  schema: PlannerNote
  field_count: 11
  description: A planner note
- entity: PlannerOverride
  schema: PlannerOverride
  field_count: 11
  description: User-controlled setting for whether an item should be displayed on the planner or not
- entity: Poll
  schema: Poll
  field_count: 6
- entity: PollChoice
  schema: PollChoice
  field_count: 5
- entity: PollSession
  schema: PollSession
  field_count: 9
- entity: PollSubmission
  schema: PollSubmission
  field_count: 4
- entity: Proficiency
  schema: Proficiency
  field_count: 1
- entity: ProficiencyRating
  schema: ProficiencyRating
  field_count: 4
- entity: Profile
  schema: Profile
  field_count: 17
  description: Profile details for a Canvas user.
- entity: Progress
  schema: Progress__course_pace
  field_count: 12
- entity: Progress
  schema: Progress__new_quizzes_reports
  field_count: 10
- entity: Progress
  schema: Progress__progress
  field_count: 12
- entity: ProvisionalGrade
  schema: ProvisionalGrade
  field_count: 7
- entity: QuestionFeedback
  schema: QuestionFeedback
  field_count: 3
- entity: QuestionItem
  schema: QuestionItem
  field_count: 13
- entity: Quiz
  schema: Quiz
  field_count: 39
- entity: QuizAccommodationRequest
  schema: QuizAccommodationRequest
  field_count: 4
  description: Request format for setting quiz-level accommodations
- entity: QuizAssignmentOverride
  schema: QuizAssignmentOverride
  field_count: 6
  description: Set of assignment-overridden dates for a quiz.
- entity: QuizAssignmentOverrideSet
  schema: QuizAssignmentOverrideSet
  field_count: 3
  description: Set of assignment-overridden dates for a quiz.
- entity: QuizAssignmentOverrideSetContainer
  schema: QuizAssignmentOverrideSetContainer
  field_count: 1
  description: Container for set of assignment-overridden dates for a quiz.
- entity: QuizExtension
  schema: QuizExtension
  field_count: 6
- entity: QuizGroup
  schema: QuizGroup
  field_count: 7
- entity: QuizIPFilter
  schema: QuizIPFilter
  field_count: 3
- entity: QuizItem
  schema: QuizItem
  field_count: 9
  description: Individual items within a quiz, whether they're questions, stimuli, banked content, or question banks.
- entity: QuizPermissions
  schema: QuizPermissions
  field_count: 7
  description: Permissions the user has for the quiz
- entity: QuizQuestion
  schema: QuizQuestion
  field_count: 13
- entity: QuizReport
  schema: QuizReport
  field_count: 13
- entity: QuizSettings
  schema: QuizSettings
  field_count: 13
- entity: QuizStatistics
  schema: QuizStatistics
  field_count: 10
- entity: QuizStatisticsAnswerPointBiserial
  schema: QuizStatisticsAnswerPointBiserial
  field_count: 4
  description: A point-biserial construct for a single pre-defined answer in a Multiple-Choice or True/False question.
- entity: QuizStatisticsAnswerStatistics
  schema: QuizStatisticsAnswerStatistics
  field_count: 4
  description: Statistics for a specific pre-defined answer in a Multiple-Choice or True/False quiz question.
- entity: QuizStatisticsLinks
  schema: QuizStatisticsLinks
  field_count: 1
  description: Links to media related to QuizStatistics.
- entity: QuizStatisticsQuestionStatistics
  schema: QuizStatisticsQuestionStatistics
  field_count: 2
  description: Statistics for submissions made to a specific quiz question.
- entity: QuizStatisticsSubmissionStatistics
  schema: QuizStatisticsSubmissionStatistics
  field_count: 9
  description: Generic statistics for all submissions for a quiz.
- entity: QuizSubmission
  schema: QuizSubmission
  field_count: 19
- entity: QuizSubmissionEvent
  schema: QuizSubmissionEvent
  field_count: 3
  description: An event passed from the Quiz Submission take page
- entity: QuizSubmissionQuestion
  schema: QuizSubmissionQuestion
  field_count: 4
- entity: QuizSubmissionUserList
  schema: QuizSubmissionUserList
  field_count: 0
- entity: QuizSubmissionUserListMeta
  schema: QuizSubmissionUserListMeta
  field_count: 0
- entity: ReportParameters
  schema: ReportParameters__account_reports
  field_count: 18
  description: The parameters returned will vary for each report.
- entity: ReportParameters
  schema: ReportParameters__course_reports
  field_count: 0
  description: The parameters returned will vary for each report.
- entity: Report
  schema: Report__account_reports
  field_count: 13
- entity: Report
  schema: Report__course_reports
  field_count: 9
- entity: ResultLinks
  schema: ResultLinks
  field_count: 3
  description: Unique identifiers of objects associated with a result
- entity: ResultViewSettings
  schema: ResultViewSettings
  field_count: 14
- entity: Result
  schema: Result__live_assessments
  field_count: 4
  description: A pass/fail results for a student
- entity: Result
  schema: Result__result
  field_count: 6
- entity: Role
  schema: Role
  field_count: 10
- entity: RolePermissions
  schema: RolePermissions
  field_count: 7
- entity: Rubric
  schema: Rubric
  field_count: 12
- entity: RubricAssessment
  schema: RubricAssessment
  field_count: 11
- entity: RubricAssociation
  schema: RubricAssociation
  field_count: 10
- entity: RubricCriteria
  schema: RubricCriteria
  field_count: 9
- entity: RubricCriterion
  schema: RubricCriterion
  field_count: 6
- entity: RubricRating
  schema: RubricRating__assignments
  field_count: 4
- entity: RubricRating
  schema: RubricRating__rubrics
  field_count: 5
- entity: SSOSettings
  schema: SSOSettings
  field_count: 6
  description: Settings that are applicable across an account's authentication configuration, even if there are
    multiple individual providers
- entity: Scope
  schema: Scope
  field_count: 6
- entity: Score
  schema: Score
  field_count: 8
- entity: ScoreStatistic
  schema: ScoreStatistic
  field_count: 6
  description: Used by Assignment model
- entity: SearchResult
  schema: SearchResult
  field_count: 6
  description: Reference to an object that matches a smart search
- entity: SearchableAccount
  schema: SearchableAccount
  field_count: 4
  description: A minimal representation of an Account for Canvas Apps search purposes
- entity: SearchableCourse
  schema: SearchableCourse
  field_count: 5
  description: A minimal representation of a Course for Canvas Apps search purposes
- entity: Section
  schema: Section
  field_count: 13
- entity: SectionAssignmentOverrideAttributes
  schema: SectionAssignmentOverrideAttributes
  field_count: 4
  description: Attributes of an assignment override that apply to the section object.  See Assignments API for more
    details
- entity: SectionAttributes
  schema: SectionAttributes
  field_count: 7
  description: Some of the attributes of a section. For more details see Sections API.
- entity: SharedBrandConfig
  schema: SharedBrandConfig
  field_count: 6
- entity: SisAssignment
  schema: SisAssignment
  field_count: 15
  description: Assignments that have post_to_sis enabled with other objects for convenience
- entity: SisImport
  schema: SisImport
  field_count: 24
- entity: SisImportCounts
  schema: SisImportCounts
  field_count: 16
- entity: SisImportData
  schema: SisImportData
  field_count: 3
- entity: SisImportError
  schema: SisImportError
  field_count: 5
- entity: SisImportStatistic
  schema: SisImportStatistic
  field_count: 5
- entity: SisImportStatistics
  schema: SisImportStatistics
  field_count: 14
- entity: StimulusItem
  schema: StimulusItem
  field_count: 9
- entity: StudentAttributes
  schema: StudentAttributes
  field_count: 2
  description: Attributes of student.  See Users API for more details
- entity: SubmissionComment
  schema: SubmissionComment
  field_count: 8
- entity: SubmissionHistory
  schema: SubmissionHistory
  field_count: 2
- entity: SubmissionVersion
  schema: SubmissionVersion
  field_count: 23
  description: A SubmissionVersion object contains all the fields that a Submission object does, plus additional
    fields prefixed with current_* new_* and previous_* described below.
- entity: Submission
  schema: Submission__plagiarism_detection_submissions
  field_count: 12
- entity: Submission
  schema: Submission__submissions
  field_count: 31
- entity: Submission
  schema: Submission__what_if_grades
  field_count: 2
- entity: Tab
  schema: Tab
  field_count: 7
- entity: TemporaryEnrollmentPairing
  schema: TemporaryEnrollmentPairing
  field_count: 2
  description: A pairing unique to that enrollment period given to a recipient of that temporary enrollment.
- entity: Term
  schema: Term
  field_count: 4
- entity: TermsOfService
  schema: TermsOfService
  field_count: 6
- entity: Token
  schema: Token
  field_count: 13
- entity: ToolSetting
  schema: ToolSetting
  field_count: 2
- entity: TurnitinSettings
  schema: TurnitinSettings
  field_count: 8
- entity: UpdatedEventData
  schema: UpdatedEventData
  field_count: 4
  description: The updated event data object returns all the fields that have changed in the format of the following
    example.  If a field does not exist it was not changed.  The value is an array that contains the before and
    after values for the change as in [:old_value, :new_value].
- entity: UsageRights
  schema: UsageRights
  field_count: 6
  description: Describes the copyright and license information for a File
- entity: User
  schema: User
  field_count: 19
  description: A Canvas user, e.g. a student, teacher, administrator, observer, etc.
- entity: UserAssignmentOverrideAttributes
  schema: UserAssignmentOverrideAttributes
  field_count: 6
  description: Attributes of assignment overrides that apply to users.  See Assignments API for more details
- entity: UserDisplay
  schema: UserDisplay
  field_count: 4
  description: This mini-object is used for secondary user responses, when we just want to provide enough information
    to display a user.
- entity: ePortfolio
  schema: ePortfolio
  field_count: 9
- entity: ePortfolioPage
  schema: ePortfolioPage
  field_count: 7
relationships:
- from: AccessibilityCourseStatistic
  to: Course
  via: course_id
  kind: belongs_to
  source: id-reference
- from: Account
  to: SisImport
  via: sis_import_id
  kind: belongs_to
  source: id-reference
- from: AiExperience
  to: Course
  via: course_id
  kind: belongs_to
  source: id-reference
- from: AppointmentGroup
  to: Appointment
  via: reserved_times
  kind: has_many
  source: $ref
- from: AssessmentQuestion
  to: AssessmentQuestionBank
  via: assessment_question_bank_id
  kind: belongs_to
  source: id-reference
- from: Assignment
  to: AssignmentDate
  via: all_dates
  kind: has_many
  source: $ref
- from: Assignment
  to: Course
  via: course_id
  kind: belongs_to
  source: id-reference
- from: Assignment
  to: AssignmentGroup
  via: assignment_group_id
  kind: belongs_to
  source: id-reference
- from: Assignment
  to: GroupCategory
  via: group_category_id
  kind: belongs_to
  source: id-reference
- from: Assignment
  to: NeedsGradingCount
  via: needs_grading_count_by_section
  kind: has_many
  source: $ref
- from: Assignment
  to: GradingStandard
  via: grading_standard_id
  kind: belongs_to
  source: id-reference
- from: Assignment
  to: Quiz
  via: quiz_id
  kind: belongs_to
  source: id-reference
- from: Assignment
  to: RubricCriteria
  via: rubric
  kind: has_many
  source: $ref
- from: Assignment
  to: AssignmentOverride
  via: overrides
  kind: has_many
  source: $ref
- from: AssignmentExtension
  to: Assignment
  via: assignment_id
  kind: belongs_to
  source: id-reference
- from: AssignmentExtension
  to: User
  via: user_id
  kind: belongs_to
  source: id-reference
- from: AssignmentOverride
  to: Assignment
  via: assignment_id
  kind: belongs_to
  source: id-reference
- from: AssignmentOverride
  to: Quiz
  via: quiz_id
  kind: belongs_to
  source: id-reference
- from: AssignmentOverride
  to: DiscussionTopic
  via: discussion_topic_id
  kind: belongs_to
  source: id-reference
- from: AssignmentOverride
  to: Group
  via: group_id
  kind: belongs_to
  source: id-reference
- from: AuthenticationEvent
  to: Account
  via: account_id
  kind: belongs_to
  source: id-reference
- from: AuthenticationEvent
  to: User
  via: user_id
  kind: belongs_to
  source: id-reference
- from: BlueprintMigration
  to: User
  via: user_id
  kind: belongs_to
  source: id-reference
- from: BlueprintTemplate
  to: Course
  via: course_id
  kind: belongs_to
  source: id-reference
- from: CalendarEvent
  to: AppointmentGroup
  via: appointment_group_id
  kind: belongs_to
  source: id-reference
- from: Collaboration
  to: User
  via: user_id
  kind: belongs_to
  source: id-reference
- from: ColumnDatum
  to: User
  via: user_id
  kind: belongs_to
  source: id-reference
- from: CommunicationChannel
  to: User
  via: user_id
  kind: belongs_to
  source: id-reference
- from: Conference
  to: ConferenceRecording
  via: recordings
  kind: has_many
  source: $ref
- from: ContentExport
  to: User
  via: user_id
  kind: belongs_to
  source: id-reference
- from: ContentMigration
  to: User
  via: user_id
  kind: belongs_to
  source: id-reference
- from: ContentShare
  to: User
  via: user_id
  kind: belongs_to
  source: id-reference
- from: ContextExternalTool
  to: DeveloperKey
  via: developer_key_id
  kind: belongs_to
  source: id-reference
- from: ContextExternalTool
  to: ContextExternalToolMessageSettings
  via: message_settings
  kind: has_many
  source: $ref
- from: ContextSearchResponse
  to: SearchableAccount
  via: accounts
  kind: has_many
  source: $ref
- from: ContextSearchResponse
  to: SearchableCourse
  via: courses
  kind: has_many
  source: $ref
- from: Conversation
  to: ConversationParticipant
  via: participants
  kind: has_many
  source: $ref
- from: Course
  to: SisImport
  via: sis_import_id
  kind: belongs_to
  source: id-reference
- from: Course
  to: Account
  via: account_id
  kind: belongs_to
  source: id-reference
- from: Course
  to: EnrollmentTerm
  via: enrollment_term_id
  kind: belongs_to
  source: id-reference
- from: Course
  to: GradingStandard
  via: grading_standard_id
  kind: belongs_to
  source: id-reference
- from: CourseAccommodationRequest
  to: User
  via: user_id
  kind: belongs_to
  source: id-reference
- from: CourseNickname
  to: Course
  via: course_id
  kind: belongs_to
  source: id-reference
- from: CoursePace
  to: Course
  via: course_id
  kind: belongs_to
  source: id-reference
- from: CoursePace
  to: User
  via: user_id
  kind: belongs_to
  source: id-reference
- from: CourseQuizExtension
  to: User
  via: user_id
  kind: belongs_to
  source: id-reference
- from: DeveloperKey
  to: User
  via: user_id
  kind: belongs_to
  source: id-reference
- from: DeveloperKeyAccountBinding
  to: Account
  via: account_id
  kind: belongs_to
  source: id-reference
- from: DeveloperKeyAccountBinding
  to: DeveloperKey
  via: developer_key_id
  kind: belongs_to
  source: id-reference
- from: DiscoveryPage
  to: DiscoveryPageEntry
  via: primary
  kind: has_many
  source: $ref
- from: DiscoveryPage
  to: DiscoveryPageEntry
  via: secondary
  kind: has_many
  source: $ref
- from: DiscoveryPageEntry
  to: AuthenticationProvider
  via: authentication_provider_id
  kind: belongs_to
  source: id-reference
- from: DiscussionTopic
  to: Assignment
  via: assignment_id
  kind: belongs_to
  source: id-reference
- from: DiscussionTopic
  to: GroupCategory
  via: group_category_id
  kind: belongs_to
  source: id-reference
- from: DiscussionTopic
  to: FileAttachment
  via: attachments
  kind: has_many
  source: $ref
- from: Enrollment
  to: Course
  via: course_id
  kind: belongs_to
  source: id-reference
- from: Enrollment
  to: SisImport
  via: sis_import_id
  kind: belongs_to
  source: id-reference
- from: Enrollment
  to: User
  via: user_id
  kind: belongs_to
  source: id-reference
- from: Enrollment
  to: Role
  via: role_id
  kind: belongs_to
  source: id-reference
- from: EnrollmentTerm
  to: SisImport
  via: sis_import_id
  kind: belongs_to
  source: id-reference
- from: EnrollmentTermsList
  to: EnrollmentTerm
  via: enrollment_terms
  kind: has_many
  source: $ref
- from: EpubExport
  to: User
  via: user_id
  kind: belongs_to
  source: id-reference
- from: ExceptionRecord
  to: Course
  via: course_id
  kind: belongs_to
  source: id-reference
- from: File
  to: Folder
  via: folder_id
  kind: belongs_to
  source: id-reference
- from: GradeGroup
  to: Submission
  via: submission_id
  kind: belongs_to
  source: id-reference
- from: GradingStandard
  to: GradingSchemeEntry
  via: grading_scheme
  kind: has_many
  source: $ref
- from: Group
  to: Course
  via: course_id
  kind: belongs_to
  source: id-reference
- from: Group
  to: GroupCategory
  via: group_category_id
  kind: belongs_to
  source: id-reference
- from: Group
  to: SisImport
  via: sis_import_id
  kind: belongs_to
  source: id-reference
- from: GroupCategory
  to: Account
  via: account_id
  kind: belongs_to
  source: id-reference
- from: GroupCategory
  to: SisImport
  via: sis_import_id
  kind: belongs_to
  source: id-reference
- from: GroupMembership
  to: Group
  via: group_id
  kind: belongs_to
  source: id-reference
- from: GroupMembership
  to: User
  via: user_id
  kind: belongs_to
  source: id-reference
- from: GroupMembership
  to: SisImport
  via: sis_import_id
  kind: belongs_to
  source: id-reference
- from: HelpLinks
  to: HelpLink
  via: custom_help_links
  kind: has_many
  source: $ref
- from: HelpLinks
  to: HelpLink
  via: default_help_links
  kind: has_many
  source: $ref
- from: LatePolicy
  to: Course
  via: course_id
  kind: belongs_to
  source: id-reference
- from: LearningObjectDates
  to: LearningObjectDates
  via: checkpoints
  kind: has_many
  source: $ref
- from: ListLtiRegistrationsResponse
  to: Lti::Registration
  via: data
  kind: has_many
  source: $ref
- from: Lti::ContextControl
  to: Course
  via: course_id
  kind: belongs_to
  source: id-reference
- from: Lti::ContextControl
  to: Account
  via: account_id
  kind: belongs_to
  source: id-reference
- from: Lti::OverlayVersion
  to: Account
  via: account_id
  kind: belongs_to
  source: id-reference
- from: Lti::Registration
  to: Account
  via: account_id
  kind: belongs_to
  source: id-reference
- from: Lti::RegistrationAccountBinding
  to: Account
  via: account_id
  kind: belongs_to
  source: id-reference
- from: Lti::ResourceLink
  to: ContextExternalTool
  via: context_external_tool_id
  kind: belongs_to
  source: id-reference
- from: Lti::ToolConfiguration
  to: Lti::Placement
  via: placements
  kind: has_many
  source: $ref
- from: LtiAssignment
  to: Course
  via: course_id
  kind: belongs_to
  source: id-reference
- from: MediaTrack
  to: User
  via: user_id
  kind: belongs_to
  source: id-reference
- from: MediaTrack
  to: MediaObject
  via: media_object_id
  kind: belongs_to
  source: id-reference
- from: ModuleItemSequence
  to: ModuleItemSequenceNode
  via: items
  kind: has_many
  source: $ref
- from: ModuleItemSequence
  to: Module
  via: modules
  kind: has_many
  source: $ref
- from: ModuleItem
  to: CoursePace
  via: course_pace_id
  kind: belongs_to
  source: id-reference
- from: ModuleItem
  to: Module
  via: module_id
  kind: belongs_to
  source: id-reference
- from: Module
  to: ModuleItem
  via: items
  kind: has_many
  source: $ref
- from: NamesAndRoleMembership
  to: User
  via: user_id
  kind: belongs_to
  source: id-reference
- from: NamesAndRoleMembership
  to: NamesAndRoleMessage
  via: message
  kind: has_many
  source: $ref
- from: NamesAndRoleMemberships
  to: NamesAndRoleMembership
  via: members
  kind: has_many
  source: $ref
- from: NeedsGradingCount
  to: Section
  via: section_id
  kind: belongs_to
  source: id-reference
- from: NewQuiz
  to: AssignmentGroup
  via: assignment_group_id
  kind: belongs_to
  source: id-reference
- from: NoticeCatalog
  to: NoticeHandler
  via: notice_handlers
  kind: has_many
  source: $ref
- from: OriginalityReport
  to: File
  via: file_id
  kind: belongs_to
  source: id-reference
- from: OutcomeAlignment
  to: Assignment
  via: assignment_id
  kind: belongs_to
  source: id-reference
- from: OutcomeAlignment
  to: Assessment
  via: assessment_id
  kind: belongs_to
  source: id-reference
- from: PageView
  to: DeveloperKey
  via: developer_key_id
  kind: belongs_to
  source: id-reference
- from: PairingCode
  to: User
  via: user_id
  kind: belongs_to
  source: id-reference
- from: PeerReview
  to: User
  via: user_id
  kind: belongs_to
  source: id-reference
- from: PlannerNote
  to: User
  via: user_id
  kind: belongs_to
  source: id-reference
- from: PlannerNote
  to: Course
  via: course_id
  kind: belongs_to
  source: id-reference
- from: PlannerOverride
  to: User
  via: user_id
  kind: belongs_to
  source: id-reference
- from: PlannerOverride
  to: Assignment
  via: assignment_id
  kind: belongs_to
  source: id-reference
- from: Poll
  to: User
  via: user_id
  kind: belongs_to
  source: id-reference
- from: PollChoice
  to: Poll
  via: poll_id
  kind: belongs_to
  source: id-reference
- from: PollSession
  to: Poll
  via: poll_id
  kind: belongs_to
  source: id-reference
- from: PollSession
  to: Course
  via: course_id
  kind: belongs_to
  source: id-reference
- from: PollSubmission
  to: PollChoice
  via: poll_choice_id
  kind: belongs_to
  source: id-reference
- from: PollSubmission
  to: User
  via: user_id
  kind: belongs_to
  source: id-reference
- from: Progress
  to: User
  via: user_id
  kind: belongs_to
  source: id-reference
- from: Quiz
  to: AssignmentGroup
  via: assignment_group_id
  kind: belongs_to
  source: id-reference
- from: QuizAccommodationRequest
  to: User
  via: user_id
  kind: belongs_to
  source: id-reference
- from: QuizAssignmentOverrideSet
  to: Quiz
  via: quiz_id
  kind: belongs_to
  source: id-reference
- from: QuizAssignmentOverrideSetContainer
  to: QuizAssignmentOverrideSet
  via: quiz_assignment_overrides
  kind: has_many
  source: $ref
- from: QuizExtension
  to: Quiz
  via: quiz_id
  kind: belongs_to
  source: id-reference
- from: QuizExtension
  to: User
  via: user_id
  kind: belongs_to
  source: id-reference
- from: QuizGroup
  to: Quiz
  via: quiz_id
  kind: belongs_to
  source: id-reference
- from: QuizGroup
  to: AssessmentQuestionBank
  via: assessment_question_bank_id
  kind: belongs_to
  source: id-reference
- from: QuizQuestion
  to: Quiz
  via: quiz_id
  kind: belongs_to
  source: id-reference
- from: QuizQuestion
  to: AssessmentQuestionBank
  via: assessment_question_bank_id
  kind: belongs_to
  source: id-reference
- from: QuizQuestion
  to: Answer
  via: answers
  kind: has_many
  source: $ref
- from: QuizReport
  to: Quiz
  via: quiz_id
  kind: belongs_to
  source: id-reference
- from: QuizStatistics
  to: Quiz
  via: quiz_id
  kind: belongs_to
  source: id-reference
- from: QuizStatisticsAnswerPointBiserial
  to: Answer
  via: answer_id
  kind: belongs_to
  source: id-reference
- from: QuizSubmission
  to: Quiz
  via: quiz_id
  kind: belongs_to
  source: id-reference
- from: QuizSubmission
  to: User
  via: user_id
  kind: belongs_to
  source: id-reference
- from: QuizSubmission
  to: Submission
  via: submission_id
  kind: belongs_to
  source: id-reference
- from: ReportParameters
  to: EnrollmentTerm
  via: enrollment_term_id
  kind: belongs_to
  source: id-reference
- from: ReportParameters
  to: Course
  via: course_id
  kind: belongs_to
  source: id-reference
- from: Rubric
  to: RubricCriterion
  via: data
  kind: has_many
  source: $ref
- from: Rubric
  to: RubricAssessment
  via: assessments
  kind: has_many
  source: $ref
- from: Rubric
  to: RubricAssociation
  via: associations
  kind: has_many
  source: $ref
- from: RubricAssessment
  to: Rubric
  via: rubric_id
  kind: belongs_to
  source: id-reference
- from: RubricAssessment
  to: RubricAssociation
  via: rubric_association_id
  kind: belongs_to
  source: id-reference
- from: RubricAssociation
  to: Rubric
  via: rubric_id
  kind: belongs_to
  source: id-reference
- from: RubricCriteria
  to: RubricRating
  via: ratings
  kind: has_many
  source: $ref
- from: RubricCriterion
  to: RubricRating
  via: ratings
  kind: has_many
  source: $ref
- from: Section
  to: SisImport
  via: sis_import_id
  kind: belongs_to
  source: id-reference
- from: Section
  to: Course
  via: course_id
  kind: belongs_to
  source: id-reference
- from: SharedBrandConfig
  to: Account
  via: account_id
  kind: belongs_to
  source: id-reference
- from: SisAssignment
  to: Course
  via: course_id
  kind: belongs_to
  source: id-reference
- from: SisAssignment
  to: AssignmentGroupAttributes
  via: assignment_group
  kind: has_many
  source: $ref
- from: SisAssignment
  to: SectionAttributes
  via: sections
  kind: has_many
  source: $ref
- from: SisAssignment
  to: UserAssignmentOverrideAttributes
  via: user_overrides
  kind: has_many
  source: $ref
- from: SisImportError
  to: SisImport
  via: sis_import_id
  kind: belongs_to
  source: id-reference
- from: StudentAttributes
  to: User
  via: user_id
  kind: belongs_to
  source: id-reference
- from: SubmissionHistory
  to: Submission
  via: submission_id
  kind: belongs_to
  source: id-reference
- from: SubmissionHistory
  to: SubmissionVersion
  via: versions
  kind: has_many
  source: $ref
- from: SubmissionVersion
  to: Assignment
  via: assignment_id
  kind: belongs_to
  source: id-reference
- from: SubmissionVersion
  to: Grader
  via: grader_id
  kind: belongs_to
  source: id-reference
- from: SubmissionVersion
  to: User
  via: user_id
  kind: belongs_to
  source: id-reference
- from: Submission
  to: Course
  via: course_id
  kind: belongs_to
  source: id-reference
- from: Submission
  to: Assignment
  via: assignment_id
  kind: belongs_to
  source: id-reference
- from: Submission
  to: User
  via: user_id
  kind: belongs_to
  source: id-reference
- from: Submission
  to: SubmissionComment
  via: submission_comments
  kind: has_many
  source: $ref
- from: Submission
  to: Grader
  via: grader_id
  kind: belongs_to
  source: id-reference
- from: TermsOfService
  to: Account
  via: account_id
  kind: belongs_to
  source: id-reference
- from: Token
  to: User
  via: user_id
  kind: belongs_to
  source: id-reference
- from: User
  to: SisImport
  via: sis_import_id
  kind: belongs_to
  source: id-reference
- from: UserAssignmentOverrideAttributes
  to: StudentAttributes
  via: students
  kind: has_many
  source: $ref
- from: ePortfolio
  to: User
  via: user_id
  kind: belongs_to
  source: id-reference
bulk_access:
  name: Data Access Platform (Canvas Data 2)
  note: The relational, warehouse-shaped view of the same data — with a published ERD — is DAP, not the REST API.
  erd: https://data-access-platform-api.s3.amazonaws.com/erd/index.html
  docs: https://developerdocs.instructure.com/services/dap