Canvas integration: operations for AI agents
Canvas connects to Type.com as an integration. This page lists the 1132 operations documented for Claude and Codex in Type.com: 571 read, 234 write, 327 destructive.
About Canvas
Canvas is a learning management system supporting online courses, assignments, grading, and collaboration, widely used by schools and universities for virtual classrooms
Categories: Education
How to connect Canvas to Type.com
- Connect
- Access token
- Access
- Organization connection: one shared account for the workspace.
To add the connection, follow the steps in Space connections.
Documented operations
1132 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.
1132 operations listed.
Access Tokens
- Read
List access tokens for a user
Returns a list of manually generated access tokens for the specified user. Note that the actual token values are only returned when the token is first created.
GET /v1/users/{user_id}/user_generated_tokens - Read
Show an access token
The ID can be the actual database ID of the token, or the 'tokenhint' value.
GET /v1/users/{user_id}/tokens/{id} - Write
Create an access token
Create a new access token for the specified user. If the user is not the current user, the token will be created as "pending", and must be activated by the user before it can be used.
POST /v1/users/{user_id}/tokens - Destructive
Update an access token
Update an existing access token. The ID can be the actual database ID of the token, or the 'tokenhint' value. Regenerating an expired token requires a new expiration date.
PUT /v1/users/{user_id}/tokens/{id} - Destructive
Delete an access token
The ID can be the actual database ID of the token, or the 'tokenhint' value.
DELETE /v1/users/{user_id}/tokens/{id}
Accessibility Course Scans
- Read
Get latest accessibility course scan
Returns the most recent bulk accessibility scan Progress for this user, whether it's still in progress or already finished -- null if the user has never triggered a scan. Unlike the trigger endpoint, this never starts a scan; it's safe to call just to check status (e.g. on page load, to resume showing an in-progress scan or to know when the last one finished). Requires the educatordashboard feature flag on the root account and a11ycheckeraccountstatistics on site admin.
GET /v1/users/{user_id}/educator_accessibility_course_scan - Write
Trigger accessibility course scan
Queues a background job that scans all a11y-enabled courses where the user has an active teacher or designer enrollment. Idempotent — if a scan is already queued or running, the existing Progress is returned. Requires the educatordashboard feature flag on the root account and a11ycheckeraccountstatistics on site admin.
POST /v1/users/{user_id}/educator_accessibility_course_scan
Accessibility Course Statistics
- Read
List accessibility course statistics
Returns per-course accessibility issue statistics for the current user's active teacher and designer courses. Only courses where the accessibility checker is enabled, that are not deleted, and that have not concluded (by workflow state or by course/term end date) are included. Only statistic records with workflowstate "active", "queued" or "inprogress" are returned. Queued and inprogress records are being recalculated, and a record that has never been calculated has null issue counts. Requires the educatordashboard feature flag to be enabled on the root account, and a11ycheckeraccountstatistics on site admin plus a11ychecker on the account (i.e. a11ycheckeraccountstatistics? must be true). The X-Total-Items response header contains the total number of matching courses across all pages.
GET /v1/users/{user_id}/educator_accessibility_course_statistics - Read
List accessibility course statistic terms
Returns the distinct enrollment terms that the current user's active teacher and designer courses belong to -- the same courses reported by the List accessibility course statistics endpoint. Use this to populate a term filter for that endpoint. There is no "all terms" entry; "all terms" is represented by omitting the enrollmenttermid filter. Requires the same account settings and feature flags as the statistics endpoint.
GET /v1/users/{user_id}/educator_accessibility_course_terms
Account Calendars
- Read
List available account calendars
Returns a paginated list of account calendars available to the current user. Includes visible account calendars where the user has an account association.
GET /v1/account_calendars - Read
Get a single account calendar
Get details about a specific account calendar.
GET /v1/account_calendars/{account_id} - Read
List all account calendars
Returns a paginated list of account calendars for the provided account and its first level of sub-accounts. Includes hidden calendars in the response. Requires the manageaccountcalendarvisibility permission.
GET /v1/accounts/{account_id}/account_calendars - Read
Count of all visible account calendars
Returns the number of visible account calendars.
GET /v1/accounts/{account_id}/visible_calendars_count - Destructive
Update a calendar
Set an account calendar's visibility and autosubscribe values. Requires the manageaccountcalendarvisibility permission on the account.
PUT /v1/account_calendars/{account_id} - Destructive
Update several calendars
Set visibility and/or autosubscribe on many calendars simultaneously. Requires the manageaccountcalendarvisibility permission on the account. Accepts a JSON array of objects containing 2-3 keys each: id (the account's id, required), visible (a boolean indicating whether the account calendar is visible), and autosubscribe (a boolean indicating whether users should see these events in their calendar without manually subscribing). Returns the count of updated accounts.
PUT /v1/accounts/{account_id}/account_calendars
Account Domain Lookups
- Read
Search account domains
Returns a list of up to 5 matching account domains Partial match on name / domain are supported
GET /v1/accounts/search
Account Notifications
- Read
Index of active global notification for the user
Returns a list of all global notifications in the account for the current user Any notifications that have been closed by the user will not be returned, unless a includepast parameter is passed in as true. Admins can request all global notifications for the account by passing in an includeall parameter.
GET /v1/accounts/{account_id}/account_notifications - Read
Show a global notification
Returns a global notification for the current user A notification that has been closed by the user will not be returned
GET /v1/accounts/{account_id}/account_notifications/{id} - Write
Create a global notification
Create and return a new global notification for an account.
POST /v1/accounts/{account_id}/account_notifications - Destructive
Update a global notification
Update global notification for an account.
PUT /v1/accounts/{account_id}/account_notifications/{id} - Destructive
Close notification for user. Destroy notification for admin
If the current user no longer wants to see this account notification, it can be closed with this call. This affects the current user only. If the current user is an admin and they pass a remove parameter with a value of "true", the account notification will be destroyed. This affects all users.
DELETE /v1/accounts/{account_id}/account_notifications/{id}
Account Reports
- Read
List Available Reports
Returns a paginated list of reports for the current context.
GET /v1/accounts/{account_id}/reports - Read
Index of Reports
Shows all reports that have been run for the account of a specific type.
GET /v1/accounts/{account_id}/reports/{report} - Read
Status of a Report
Returns the status of a report.
GET /v1/accounts/{account_id}/reports/{report}/{id} - Write
Start a Report
Generates a report instance for the account. Note that "report" in the request must match one of the available report names. To fetch a list of available report names and parameters for each report (including whether or not those parameters are required), see {api:AccountReportsControlleravailablereports List Available Reports}.
POST /v1/accounts/{account_id}/reports/{report} - Destructive
Delete a Report
Deletes a generated report instance.
DELETE /v1/accounts/{account_id}/reports/{report}/{id} - Destructive
Abort a Report
Abort a report in progress
PUT /v1/accounts/{account_id}/reports/{report}/{id}/abort
Accounts
- Read
List accounts
A paginated list of accounts that the current user can view or manage. Typically, students and even teachers will get an empty list in response, only account admins can view the accounts that they are in.
GET /v1/accounts - Read
List horizon accounts
A paginated list of horizon accounts that the current user can view or manage. Returns all accounts with the horizonaccount setting enabled. If there are any horizon accounts and the user has access to Site Admin, Site Admin will also be included in the results. Typically, students and even teachers will get an empty list in response, only account admins can view the accounts that they are in.
GET /v1/horizon_accounts - Read
Get accounts that admins can manage
A paginated list of accounts where the current user has permission to create or manage courses. List will be empty for students and teachers as only admins can view which accounts they are in.
GET /v1/manageable_accounts - Read
Get accounts that users can create courses in
A paginated list of accounts where the current user has permission to create courses.
GET /v1/course_creation_accounts - Read
List accounts for course admins
A paginated list of accounts that the current user can view through their admin course enrollments. (Teacher, TA, or designer enrollments). Only returns "id", "name", "workflowstate", "rootaccountid" and "parentaccountid"
GET /v1/course_accounts - Read
Get a single account
Retrieve information on an individual account, given by id or sis sisaccountid.
GET /v1/accounts/{id} - Read
Settings
Returns a JSON object containing a subset of settings for the specified account. It's possible an empty set will be returned if no settings are applicable. The caller must be an Account admin with the manageaccountsettings permission.
GET /v1/accounts/{account_id}/settings - Read
List environment settings
Return a hash of global settings for the root account This is the same information supplied to the web interface as +ENV.SETTINGS+.
GET /v1/settings/environment - Read
Permissions
Returns permission information for the calling user and the given account. You may use self as the account id to check permissions against the domain root account. The caller must have an account role or admin (teacher/TA/designer) enrollment in a course in the account. See also the {api:CoursesControllerpermissions Course} and {api:GroupsControllerpermissions Group} counterparts.
GET /v1/accounts/{account_id}/permissions - Read
Get the sub-accounts of an account
List accounts that are sub-accounts of the given account.
GET /v1/accounts/{account_id}/sub_accounts - Read
Get the Terms of Service
Returns the terms of service for that account
GET /v1/accounts/{account_id}/terms_of_service - Read
Get help links
Returns the help links for that account
GET /v1/accounts/{account_id}/help_links - Read
Get the manually-created courses sub-account for the domain root account
Returns the sub-account that contains manually created courses for the domain root account.
GET /v1/manually_created_courses_account - Read
List active courses in an account
Retrieve a paginated list of courses in this account.
GET /v1/accounts/{account_id}/courses - Write
Create a new sub-account
Add a new sub-account to a given account.
POST /v1/accounts/{account_id}/sub_accounts - Destructive
Update an account
Update an existing account.
PUT /v1/accounts/{id} - Destructive
Delete a user from the root account
Delete a user record from a Canvas root account. If a user is associated with multiple root accounts (in a multi-tenant instance of Canvas), this action will NOT remove them from the other accounts. WARNING: This API will allow a user to remove themselves from the account. If they do this, they won't be able to make API calls or log into Canvas at that account.
DELETE /v1/accounts/{account_id}/users/{user_id} - Destructive
Delete multiple users from the root account
Delete multiple users from a Canvas root account. If a user is associated with multiple root accounts (in a multi-tenant instance of Canvas), this action will NOT remove them from the other accounts. WARNING: This API will allow a user to remove themselves from the account. If they do this, they won't be able to make API calls or log into Canvas at that account.
DELETE /v1/accounts/{account_id}/users - Destructive
Update multiple users
Updates multiple users in bulk.
PUT /v1/accounts/{account_id}/users/bulk_update - Destructive
Restore a deleted user from a root account
Restore a user record along with the most recently deleted pseudonym from a Canvas root account.
PUT /v1/accounts/{account_id}/users/{user_id}/restore - Destructive
Delete a sub-account
Cannot delete an account with active courses or active subaccounts. Cannot delete a rootaccount
DELETE /v1/accounts/{account_id}/sub_accounts/{id}
Accounts (LTI)
- Read
Get account
Retrieve information on an individual account, given by local or global ID.
GET /lti/accounts/{account_id}
Admins
- Read
List account admins
A paginated list of the admins in the account
GET /v1/accounts/{account_id}/admins - Read
List my admin roles
A paginated list of the current user's roles in the account. The results are the same as those returned by the {api:AdminsControllerindex List account admins} endpoint with +userid+ set to +self+.
GET /v1/accounts/{account_id}/admins/self - Write
Make an account admin
Flag an existing user as an admin within the account.
POST /v1/accounts/{account_id}/admins - Destructive
Remove account admin
Remove the rights associated with an account admin role from a user.
DELETE /v1/accounts/{account_id}/admins/{user_id}
AI Conversations
- Read
Show conversation
Get a specific conversation by ID (for teachers viewing student conversations)
GET /v1/courses/{course_id}/ai_experiences/{ai_experience_id}/conversations/{id} - Read
Get active conversation
Get the active conversation for the current user and AI experience
GET /v1/courses/{course_id}/ai_experiences/{ai_experience_id}/conversations - Read
Get conversation evaluation
Fetch the latest stored evaluation for a conversation from the llm-conversation service. Reads only — does not run the LLM and is not rate-limited. evaluation is null when none has been generated yet (llma returns 200 + null, never 404, so this is distinguishable from an outage). stale is true when the AI experience was edited after the stored evaluation was generated.
GET /v1/courses/{course_id}/ai_experiences/{ai_experience_id}/conversations/{id}/evaluation - Write
Create AI conversation
Initialize a new conversation with the AI experience
POST /v1/courses/{course_id}/ai_experiences/{ai_experience_id}/conversations - Write
Post message to conversation
Send a message to an existing conversation and get the AI response
POST /v1/courses/{course_id}/ai_experiences/{ai_experience_id}/conversations/{id}/messages - Write
Generate conversation evaluation
Run the LLM to (re)generate an evaluation for a conversation and persist it in the llm-conversation service. Rate-limited. Also the Reset path — a fresh run replaces any prior stored evaluation.
POST /v1/courses/{course_id}/ai_experiences/{ai_experience_id}/conversations/{id}/evaluation - Write
Create feedback on a conversation message
Submit a like or dislike vote on an AI-generated message. Ownership: loadconversation gates this action — only the conversation owner or a course manager reaches here. Sub-resource (messageid within the conversation) scoping is delegated to llma.
POST /v1/courses/{course_id}/ai_experiences/{ai_experience_id}/conversations/{id}/messages/{message_id}/feedback - Destructive
Delete AI conversation
End the current conversation session
DELETE /v1/courses/{course_id}/ai_experiences/{ai_experience_id}/conversations/{id} - Destructive
Delete feedback on a conversation message
Remove a previously submitted vote (toggling off like/dislike). Ownership: loadconversation gates this action — only the conversation owner or a course manager reaches here. Sub-resource (messageid, feedbackid within the conversation) scoping is delegated to llma.
DELETE /v1/courses/{course_id}/ai_experiences/{ai_experience_id}/conversations/{id}/messages/{message_id}/feedback/{feedback_id}
AI Experiences
- Read
List AI experiences
Retrieve the paginated list of AI experiences for a course
GET /v1/courses/{course_id}/ai_experiences - Read
Show an AI experience
Retrieve an AI experience by ID
GET /v1/courses/{course_id}/ai_experiences/{id} - Read
Show new AI experience form
Display the form for creating a new AI experience
GET /v1/courses/{course_id}/ai_experiences/new - Read
Show edit AI experience form
Display the form for editing an existing AI experience
GET /v1/courses/{course_id}/ai_experiences/{id}/edit - Read
List student AI conversations
Retrieve the latest AI conversation for each student in the course for this AI experience. Only available to teachers and course managers.
GET /v1/courses/{course_id}/ai_experiences/{id}/ai_conversations - Read
Show student AI conversation
Retrieve a specific student's AI conversation with full message history. Only available to teachers and course managers.
GET /v1/courses/{course_id}/ai_experiences/{id}/ai_conversations/{conversation_id} - Write
Create an AI experience
Create a new AI experience for the specified course
POST /v1/courses/{course_id}/ai_experiences - Destructive
Update an AI experience
Update an existing AI experience
PUT /v1/courses/{course_id}/ai_experiences/{id} - Destructive
Delete an AI experience
Delete an AI experience (soft delete - marks as deleted)
DELETE /v1/courses/{course_id}/ai_experiences/{id}
Analytics
- Read
Get department-level participation data
Returns page view hits summed across all courses in the department. Two groupings of these counts are returned; one by day (+bydate+), the other by category (+bycategory+). The possible categories are announcements, assignments, collaborations, conferences, discussions, files, general, grades, groups, modules, other, pages, and quizzes. This and the other department-level endpoints have three variations which all return the same style of data but for different subsets of courses. All share the prefix /api/v1/accounts/ /analytics. The possible suffixes are: /current: includes all available courses in the default term /completed: includes all concluded courses in the default term /terms/ : includes all available or concluded courses in the given term. Courses not yet offered or which have been deleted are never included. /current and /completed are intended for use when the account has only one term. /terms/ is intended for use when the account has multiple terms. The action follows the suffix.
GET /v1/accounts/{account_id}/analytics/terms/{term_id}/activity - Read
Get department-level participation data
Returns page view hits summed across all courses in the department. Two groupings of these counts are returned; one by day (+bydate+), the other by category (+bycategory+). The possible categories are announcements, assignments, collaborations, conferences, discussions, files, general, grades, groups, modules, other, pages, and quizzes. This and the other department-level endpoints have three variations which all return the same style of data but for different subsets of courses. All share the prefix /api/v1/accounts/ /analytics. The possible suffixes are: /current: includes all available courses in the default term /completed: includes all concluded courses in the default term /terms/ : includes all available or concluded courses in the given term. Courses not yet offered or which have been deleted are never included. /current and /completed are intended for use when the account has only one term. /terms/ is intended for use when the account has multiple terms. The action follows the suffix.
GET /v1/accounts/{account_id}/analytics/current/activity - Read
Get department-level participation data
Returns page view hits summed across all courses in the department. Two groupings of these counts are returned; one by day (+bydate+), the other by category (+bycategory+). The possible categories are announcements, assignments, collaborations, conferences, discussions, files, general, grades, groups, modules, other, pages, and quizzes. This and the other department-level endpoints have three variations which all return the same style of data but for different subsets of courses. All share the prefix /api/v1/accounts/ /analytics. The possible suffixes are: /current: includes all available courses in the default term /completed: includes all concluded courses in the default term /terms/ : includes all available or concluded courses in the given term. Courses not yet offered or which have been deleted are never included. /current and /completed are intended for use when the account has only one term. /terms/ is intended for use when the account has multiple terms. The action follows the suffix.
GET /v1/accounts/{account_id}/analytics/completed/activity - Read
Get department-level grade data
Returns the distribution of grades for students in courses in the department. Each data point is one student's current grade in one course; if a student is in multiple courses, he contributes one value per course, but if he's enrolled multiple times in the same course (e.g. a lecture section and a lab section), he only constributes on value for that course. Grades are binned to the nearest integer score; anomalous grades outside the 0 to 100 range are ignored. The raw counts are returned, not yet normalized by the total count. Shares the same variations on endpoint as the participation data.
GET /v1/accounts/{account_id}/analytics/terms/{term_id}/grades - Read
Get department-level grade data
Returns the distribution of grades for students in courses in the department. Each data point is one student's current grade in one course; if a student is in multiple courses, he contributes one value per course, but if he's enrolled multiple times in the same course (e.g. a lecture section and a lab section), he only constributes on value for that course. Grades are binned to the nearest integer score; anomalous grades outside the 0 to 100 range are ignored. The raw counts are returned, not yet normalized by the total count. Shares the same variations on endpoint as the participation data.
GET /v1/accounts/{account_id}/analytics/current/grades - Read
Get department-level grade data
Returns the distribution of grades for students in courses in the department. Each data point is one student's current grade in one course; if a student is in multiple courses, he contributes one value per course, but if he's enrolled multiple times in the same course (e.g. a lecture section and a lab section), he only constributes on value for that course. Grades are binned to the nearest integer score; anomalous grades outside the 0 to 100 range are ignored. The raw counts are returned, not yet normalized by the total count. Shares the same variations on endpoint as the participation data.
GET /v1/accounts/{account_id}/analytics/completed/grades - Read
Get department-level statistics
Returns numeric statistics about the department and term (or filter). Shares the same variations on endpoint as the participation data.
GET /v1/accounts/{account_id}/analytics/terms/{term_id}/statistics - Read
Get department-level statistics
Returns numeric statistics about the department and term (or filter). Shares the same variations on endpoint as the participation data.
GET /v1/accounts/{account_id}/analytics/current/statistics - Read
Get department-level statistics
Returns numeric statistics about the department and term (or filter). Shares the same variations on endpoint as the participation data.
GET /v1/accounts/{account_id}/analytics/completed/statistics - Read
Get department-level statistics, broken down by subaccount
Returns numeric statistics about the department subaccounts and term (or filter). Shares the same variations on endpoint as the participation data.
GET /v1/accounts/{account_id}/analytics/terms/{term_id}/statistics_by_subaccount - Read
Get department-level statistics, broken down by subaccount
Returns numeric statistics about the department subaccounts and term (or filter). Shares the same variations on endpoint as the participation data.
GET /v1/accounts/{account_id}/analytics/current/statistics_by_subaccount - Read
Get department-level statistics, broken down by subaccount
Returns numeric statistics about the department subaccounts and term (or filter). Shares the same variations on endpoint as the participation data.
GET /v1/accounts/{account_id}/analytics/completed/statistics_by_subaccount - Read
Get course-level participation data
Returns page view hits and participation numbers grouped by day through the entire history of the course. Page views is returned as a hash, where the hash keys are dates in the format "YYYY-MM-DD". The pageviews result set includes page views broken out by access category. Participations is returned as an array of dates in the format "YYYY-MM-DD".
GET /v1/courses/{course_id}/analytics/activity - Read
Get course-level assignment data
Returns a list of assignments for the course sorted by due date. For each assignment returns basic assignment information, the grade breakdown, and a breakdown of on-time/late status of homework submissions.
GET /v1/courses/{course_id}/analytics/assignments - Read
Get course-level student summary data
Returns a summary of per-user access information for all students in a course. This includes total page views, total participations, and a breakdown of on-time/late status for all homework submissions in the course. Each student's summary also includes the maximum number of page views and participations by any student in the course, which may be useful for some visualizations (since determining maximums client side can be tricky with pagination).
GET /v1/courses/{course_id}/analytics/student_summaries - Read
Get user-in-a-course-level participation data
Returns page view hits grouped by hour, and participation details through the entire history of the course. pageviews are returned as a hash, where the keys are iso8601 dates, bucketed by the hour. participations are returned as an array of hashes, sorted oldest to newest.
GET /v1/courses/{course_id}/analytics/users/{student_id}/activity - Read
Get user-in-a-course-level assignment data
Returns a list of assignments for the course sorted by due date. For each assignment returns basic assignment information, the grade breakdown (including the student's actual grade), and the basic submission information for the student's submission if it exists.
GET /v1/courses/{course_id}/analytics/users/{student_id}/assignments - Read
Get user-in-a-course-level messaging data
Returns messaging "hits" grouped by day through the entire history of the course. Returns a hash containing the number of instructor-to-student messages, and student-to-instructor messages, where the hash keys are dates in the format "YYYY-MM-DD". Message hits include Conversation messages and comments on homework submissions.
GET /v1/courses/{course_id}/analytics/users/{student_id}/communication
Announcement External Feeds
- Read
List external feeds
Returns the paginated list of External Feeds this course or group.
GET /v1/courses/{course_id}/external_feeds - Read
List external feeds
Returns the paginated list of External Feeds this course or group.
GET /v1/groups/{group_id}/external_feeds - Write
Create an external feed
Create a new external feed for the course or group.
POST /v1/courses/{course_id}/external_feeds - Write
Create an external feed
Create a new external feed for the course or group.
POST /v1/groups/{group_id}/external_feeds - Destructive
Delete an external feed
Deletes the external feed.
DELETE /v1/courses/{course_id}/external_feeds/{external_feed_id} - Destructive
Delete an external feed
Deletes the external feed.
DELETE /v1/groups/{group_id}/external_feeds/{external_feed_id}
Announcements
- Read
List announcements
Returns the paginated list of announcements for the given courses and date range. Note that a +contextcode+ field is added to the responses so you can tell which course each announcement belongs to.
GET /v1/announcements
API Token Scopes
- Read
List scopes
A list of scopes that can be applied to developer keys and access tokens.
GET /v1/accounts/{account_id}/scopes
Appointment Groups
- Read
List appointment groups
Retrieve the paginated list of appointment groups that can be reserved or managed by the current user.
GET /v1/appointment_groups - Read
Get a single appointment group
Returns information for a single appointment group
GET /v1/appointment_groups/{id} - Read
List user participants
A paginated list of users that are (or may be) participating in this appointment group. Refer to the Users API for the response fields. Returns no results for appointment groups with the "Group" participanttype.
GET /v1/appointment_groups/{id}/users - Read
List student group participants
A paginated list of student groups that are (or may be) participating in this appointment group. Refer to the Groups API for the response fields. Returns no results for appointment groups with the "User" participanttype.
GET /v1/appointment_groups/{id}/groups - Read
Get next appointment
Return the next appointment available to sign up for. The appointment is returned in a one-element array. If no future appointments are available, an empty array is returned.
GET /v1/appointment_groups/next_appointment - Write
Create an appointment group
Create and return a new appointment group. If newappointments are specified, the response will return a newappointments array (same format as appointments array, see "List appointment groups" action)
POST /v1/appointment_groups - Destructive
Update an appointment group
Update and return an appointment group. If newappointments are specified, the response will return a newappointments array (same format as appointments array, see "List appointment groups" action).
PUT /v1/appointment_groups/{id} - Destructive
Delete an appointment group
Delete an appointment group (and associated time slots and reservations) and return the deleted group
DELETE /v1/appointment_groups/{id}
Assessment Question Banks
- Read
List question banks
Returns the paginated list of question banks for a given context.
GET /v1/question_banks - Read
Get a single question bank
Returns the question bank with the given id
GET /v1/question_banks/{id} - Read
List assessment questions for a question bank
Returns the paginated list of assessment questions in this bank.
GET /v1/question_banks/{id}/questions
Asset Processor
- Write
Create an Asset Report
Creates a report for a given Canvas-managed asset (such as a submission attachment). Returns an HTTP 201 (Created) on success.
POST /lti/asset_processors/{asset_processor_id}/reports - Write
Create an Eula Acceptance
The EULA user acceptance service provides a mechanism by which a tool can notify a platform of whether or not a user has accepted a EULA.
POST /lti/asset_processor_eulas/{context_external_tool_id}/user - Destructive
Update Eula Deployment Configuration
Provides a mechanism by which a platform can enable or disable the requirement for users to accept a EULA within the scope of an entire deployment
PUT /lti/asset_processor_eulas/{context_external_tool_id}/deployment - Destructive
Delete Eula Acceptances for deployment
Remove the EULA acceptance status for all users within the current deployment. This will allow a tool to reset the EULA acceptance status for all users, and force them to accept the EULA again in the case that the EULA has changed.
DELETE /lti/asset_processor_eulas/{context_external_tool_id}/user
Assignment Extensions
- Write
Set extensions for student assignment submissions
Responses 200 OK if the request was successful 403 Forbidden if you are not allowed to extend assignments for this course 400 Bad Request if any of the extensions are invalid
POST /v1/courses/{course_id}/assignments/{assignment_id}/extensions
Assignment Groups
- Read
List assignment groups
Returns the paginated list of assignment groups for the current context. The returned groups are sorted by their position field.
GET /v1/courses/{course_id}/assignment_groups - Read
Get an Assignment Group
Returns the assignment group with the given id.
GET /v1/courses/{course_id}/assignment_groups/{assignment_group_id} - Write
Create an Assignment Group
Create a new assignment group for this course.
POST /v1/courses/{course_id}/assignment_groups - Destructive
Edit an Assignment Group
Modify an existing Assignment Group.
PUT /v1/courses/{course_id}/assignment_groups/{assignment_group_id} - Destructive
Destroy an Assignment Group
Deletes the assignment group with the given id.
DELETE /v1/courses/{course_id}/assignment_groups/{assignment_group_id}
Assignment Presets
- Read
List assignment presets
Returns the list of assignment presets accessible from the current context. This always includes account-level presets from the context's account chain. For a course context, it also includes the course's own presets.
GET /v1/courses/{course_id}/assignment_presets - Read
List assignment presets
Returns the list of assignment presets accessible from the current context. This always includes account-level presets from the context's account chain. For a course context, it also includes the course's own presets.
GET /v1/accounts/{account_id}/assignment_presets - Read
Get an assignment preset
Returns a single assignment preset.
GET /v1/courses/{course_id}/assignment_presets/{id} - Read
Get an assignment preset
Returns a single assignment preset.
GET /v1/accounts/{account_id}/assignment_presets/{id} - Write
Create an assignment preset
Create a new assignment preset in the given context.
POST /v1/courses/{course_id}/assignment_presets - Write
Create an assignment preset
Create a new assignment preset in the given context.
POST /v1/accounts/{account_id}/assignment_presets - Destructive
Update an assignment preset
Update an existing assignment preset.
PUT /v1/courses/{course_id}/assignment_presets/{id} - Destructive
Update an assignment preset
Update an existing assignment preset.
PUT /v1/accounts/{account_id}/assignment_presets/{id} - Destructive
Delete an assignment preset
Soft-deletes an assignment preset.
DELETE /v1/courses/{course_id}/assignment_presets/{id} - Destructive
Delete an assignment preset
Soft-deletes an assignment preset.
DELETE /v1/accounts/{account_id}/assignment_presets/{id}
Assignments
- Read
List assignments
Returns the paginated list of assignments for the current course or assignment group.
GET /v1/courses/{course_id}/assignments - Read
List assignments
Returns the paginated list of assignments for the current course or assignment group.
GET /v1/courses/{course_id}/assignment_groups/{assignment_group_id}/assignments - Read
List assignments for user
Returns the paginated list of assignments for the specified user if the current user has rights to view. See {api:AssignmentsApiControllerindex List assignments} for valid arguments.
GET /v1/users/{user_id}/courses/{course_id}/assignments - Read
List group members for a student on an assignment
Returns student ids and names for the group.
GET /v1/courses/{course_id}/assignments/{assignment_id}/users/{user_id}/group_members - Read
Get a single assignment
Returns the assignment with the given id.
GET /v1/courses/{course_id}/assignments/{id} - Read
List assignment overrides
Returns the paginated list of overrides for this assignment that target sections/groups/students visible to the current user.
GET /v1/courses/{course_id}/assignments/{assignment_id}/overrides - Read
Get a single assignment override
Returns details of the the override with the given id.
GET /v1/courses/{course_id}/assignments/{assignment_id}/overrides/{id} - Read
Redirect to the assignment override for a group
Responds with a redirect to the override for the given group, if any (404 otherwise).
GET /v1/groups/{group_id}/assignments/{assignment_id}/override - Read
Redirect to the assignment override for a section
Responds with a redirect to the override for the given section, if any (404 otherwise).
GET /v1/sections/{course_section_id}/assignments/{assignment_id}/override - Read
Batch retrieve overrides in a course
Returns a list of specified overrides in this course, providing they target sections/groups/students visible to the current user. Returns null elements in the list for requests that were not found.
GET /v1/courses/{course_id}/assignments/overrides - Write
Duplicate assignment
Duplicate an assignment and return a json based on resulttype argument.
POST /v1/courses/{course_id}/assignments/{assignment_id}/duplicate - Write
Create an assignment
Create a new assignment for this course. The assignment is created in the active state.
POST /v1/courses/{course_id}/assignments - Write
Create an assignment override
One of studentids, groupid, or coursesectionid must be present. At most one should be present; if multiple are present only the most specific (studentids first, then groupid, then coursesectionid) is used and any others are ignored.
POST /v1/courses/{course_id}/assignments/{assignment_id}/overrides - Write
Batch create overrides in a course
Creates the specified overrides for each assignment. Handles creation in a transaction, so all records are created or none are. One of studentids, groupid, or coursesectionid must be present. At most one should be present; if multiple are present only the most specific (studentids first, then groupid, then coursesectionid) is used and any others are ignored. Errors are reported in an errors attribute, an array of errors corresponding to inputs. Global errors will be reported as a single element errors array
POST /v1/courses/{course_id}/assignments/overrides - Destructive
Delete an assignment
Delete the given assignment.
DELETE /v1/courses/{course_id}/assignments/{id} - Destructive
Edit an assignment
Modify an existing assignment.
PUT /v1/courses/{course_id}/assignments/{id} - Destructive
Bulk update assignment dates
Update due dates and availability dates for multiple assignments in a course. Accepts a JSON array of objects containing two keys each: +id+, the assignment id, and +alldates+, an array of +AssignmentDate+ structures containing the base and/or override dates for the assignment, as returned from the {api:AssignmentsApiControllerindex List assignments} endpoint with +include[]=alldates+. This endpoint cannot create or destroy assignment overrides; any existing assignment overrides that are not referenced in the arguments will be left alone. If an override is given, any dates that are not supplied with it will be defaulted. To clear a date, specify null explicitly. All referenced assignments will be validated before any are saved. A list of errors will be returned if any provided dates are invalid, and no changes will be saved. The bulk update is performed in a background job, use the {api:ProgressControllershow Progress API} to check its status.
PUT /v1/courses/{course_id}/assignments/bulk_update - Destructive
Update an assignment override
All current overridden values must be supplied if they are to be retained; e.g. if dueat was overridden, but this PUT omits a value for dueat, dueat will no longer be overridden. If the override is adhoc and studentids is not supplied, the target override set is unchanged. Target override sets cannot be changed for group or section overrides.
PUT /v1/courses/{course_id}/assignments/{assignment_id}/overrides/{id} - Destructive
Delete an assignment override
Deletes an override and returns its former details.
DELETE /v1/courses/{course_id}/assignments/{assignment_id}/overrides/{id} - Destructive
Batch update overrides in a course
Updates a list of specified overrides for each assignment. Handles overrides in a transaction, so either all updates are applied or none. See {api:AssignmentOverridesControllerupdate Update an assignment override} for available attributes. All current overridden values must be supplied if they are to be retained; e.g. if dueat was overridden, but this PUT omits a value for dueat, dueat will no longer be overridden. If the override is adhoc and studentids is not supplied, the target override set is unchanged. Target override sets cannot be changed for group or section overrides. Errors are reported in an errors attribute, an array of errors corresponding to inputs. Global errors will be reported as a single element errors array
PUT /v1/courses/{course_id}/assignments/overrides
Authentication Providers
- Read
List authentication providers
Returns a paginated list of authentication providers
GET /v1/accounts/{account_id}/authentication_providers - Read
Get authentication provider
Get the specified authentication provider
GET /v1/accounts/{account_id}/authentication_providers/{id} - Read
Show account auth settings
The way to get the current state of each account level setting that's relevant to Single Sign On configuration You can list the current state of each setting with "updatessosettings"
GET /v1/accounts/{account_id}/sso_settings - Write
Add authentication provider
Add external authentication provider(s) for the account. Services may be Apple, CAS, Facebook, GitHub, Google, LDAP, LinkedIn, Microsoft, OpenID Connect, or SAML. Each authentication provider is specified as a set of parameters as described below. A provider specification must include an 'authtype' parameter with a value of 'apple', 'canvas', 'cas', 'clever', 'facebook', 'github', 'google', 'ldap', 'linkedin', 'microsoft', 'openidconnect', or 'saml'. The other recognized parameters depend on this authtype; unrecognized parameters are discarded. Provider specifications not specifying a valid authtype are ignored. You can set the 'position' for any provider. The config in the 1st position is considered the default. You can set 'jitprovisioning' for any provider besides Canvas. You can set 'mfarequired' for any provider. For Apple, the additional recognized parameters are: - clientid [Required] The developer’s client identifier, as provided by WWDR. Not available if configured globally for Canvas. - loginattribute [Optional] The attribute to use to look up the user's login in Canvas. Either 'sub' (the default), or 'email' - federatedattributes [Optional] See FederatedAttributesConfig. Valid provider attributes are 'email', 'firstName', 'lastName', and 'sub'. For Canvas, the additional recognized parameter is: - selfregistration 'all', 'none', or 'observer' - who is allowed to register as a new user For CAS, the additional recognized parameters are: - authbase The CAS server's URL. - loginurl [Optional] An alternate SSO URL for logging into CAS. You probably should not set this. For Clever, the additional recognized parameters are: - clientid [Required] The Clever application's Client ID. Not available if configured globally for Canvas. - clientsecret [Required] The Clever application's Client Secret. Not available if configured globally for Canvas. - districtid [Optional] A district's Clever ID. Leave this blank to let Clever handle the details with its District Picker. This is required for Clever Instant Login to work in a multi-tenant environment. - loginattribute [Optional] The attribute to use to look up the user's login in Canvas. Either 'id' (the default), 'sisid', 'email', 'studentnumber', or 'teachernumber'. Note that some fields may not be populated for all users at Clever. - federatedattributes [Optional] See FederatedAttributesConfig. Valid provider attributes are 'id', 'sisid', 'email', 'studentnumber', and 'teachernumber'. For Facebook, the additional recognized parameters are: - appid [Required] The Facebook App ID. Not available if configured globally for Canvas. - appsecret [Required] The Facebook App Secret. Not available if configured globally for Canvas. - loginattribute [Optional] The attribute to use to look up the user's login in Canvas. Either 'id' (the default), or 'email' - federatedattributes [Optional] See FederatedAttributesConfig. Valid provider attributes are 'email', 'firstname', 'id', 'lastname', 'locale', and 'name'. For GitHub, the additional recognized parameters are: - domain [Optional] The domain of a GitHub Enterprise installation. I.e. github.mycompany.com. If not set, it will default to the public github.com. - clientid [Required] The GitHub application's Client ID. Not available if configured globally for Canvas. - clientsecret [Required] The GitHub application's Client Secret. Not available if configured globally for Canvas. - loginattribute [Optional] The attribute to use to look up the user's login in Canvas. Either 'id' (the default), or 'login' - federatedattributes [Optional] See FederatedAttributesConfig. Valid provider attributes are 'email', 'id', 'login', and 'name'. For Google, the additional recognized parameters are: - clientid [Required] The Google application's Client ID. Not available if configured globally for Canvas. - clientsecret [Required] The Google application's Client Secret. Not available if configured globally for Canvas. - hosteddomain [Optional] A Google Apps domain to restrict logins to. See https://developers.google.com/identity/protocols/OpenIDConnect?hl=enhd-param - loginattribute [Optional] The attribute to use to look up the user's login in Canvas. Either 'sub' (the default), or 'email' - federatedattributes [Optional] See FederatedAttributesConfig. Valid provider attributes are 'email', 'familyname', 'givenname', 'locale', 'name', and 'sub'. For LDAP, the additional recognized parameters are: - authhost The LDAP server's URL. - authport [Optional, Integer] The LDAP server's TCP port. (default: 389) - authovertls [Optional] Whether to use TLS. Can be 'simpletls', or 'starttls'. For backwards compatibility, booleans are also accepted, with true meaning simpletls. If not provided, it will default to starttls. - authbase [Optional] A default treebase parameter for searches performed against the LDAP server. - authfilter LDAP search filter. Use !{{login}} as a placeholder for the username supplied by the user. For example: "(sAMAccountName=!{{login}})". - identifierformat [Optional] The LDAP attribute to use to look up the Canvas login. Omit to use the username supplied by the user. - authusername Username - authpassword Password For LinkedIn, the additional recognized parameters are: - clientid [Required] The LinkedIn application's Client ID. Not available if configured globally for Canvas. - clientsecret [Required] The LinkedIn application's Client Secret. Not available if configured globally for Canvas. - loginattribute [Optional] The attribute to use to look up the user's login in Canvas. Either 'id' (the default), or 'emailAddress' - federatedattributes [Optional] See FederatedAttributesConfig. Valid provider attributes are 'emailAddress', 'firstName', 'id', 'formattedName', and 'lastName'. For Microsoft, the additional recognized parameters are: - applicationid [Required] The application's ID. - applicationsecret [Required] The application's Client Secret (Password) - tenant [Optional] See https://azure.microsoft.com/en-us/documentation/articles/active-directory-v2-protocols/ Valid values are 'common', 'organizations', 'consumers', or an Azure Active Directory Tenant (as either a UUID or domain, such as contoso.onmicrosoft.com). Defaults to 'common' - loginattribute [Optional] See https://azure.microsoft.com/en-us/documentation/articles/active-directory-v2-tokens/idtokens Valid values are 'sub', 'email', 'oid', or 'preferredusername'. Note that email may not always be populated in the user's profile at Microsoft. Oid will not be populated for personal Microsoft accounts. Defaults to 'sub' - federatedattributes [Optional] See FederatedAttributesConfig. Valid provider attributes are 'email', 'name', 'preferredusername', 'oid', and 'sub'. For OpenID Connect, the additional recognized parameters are: - clientid [Required] The application's Client ID. - clientsecret [Required] The application's Client Secret. - authorizeurl [Required] The URL for getting starting the OAuth 2.0 web flow - tokenurl [Required] The URL for exchanging the OAuth 2.0 authorization code for an Access Token and ID Token - scope [Optional] Space separated additional scopes to request for the token. Note that you need not specify the 'openid' scope, or any scopes that can be automatically inferred by the rules defined at http://openid.net/specs/openid-connect-core-10.htmlScopeClaims - endsessionendpoint [Optional] URL to send the end user to after logging out of Canvas. See https://openid.net/specs/openid-connect-session-10.htmlRPLogout - userinfoendpoint [Optional] URL to request additional claims from. If the initial ID Token received from the provider cannot be used to satisfy the loginattribute and all federatedattributes, this endpoint will be queried for additional information. - loginattribute [Optional] The attribute of the ID Token to look up the user's login in Canvas. Defaults to 'sub'. - federatedattributes [Optional] See FederatedAttributesConfig. Any value is allowed for the provider attribute names, but standard claims are listed at http://openid.net/specs/openid-connect-core-10.htmlStandardClaims For SAML, the additional recognized parameters are: - metadata [Optional] An XML document to parse as SAML metadata, and automatically populate idpentityid, loginurl, logouturl, certificatefingerprint, and identifierformat - metadatauri [Optional] A URI to download the SAML metadata from, and automatically populate idpentityid, loginurl, logouturl, certificatefingerprint, and identifierformat. This URI will also be saved, and the metadata periodically refreshed, automatically. If the metadata contains multiple entities, also supply idpentityid to distinguish which one you want (otherwise the only entity in the metadata will be inferred). If you provide the URI 'urn:mace:incommon' or 'http://ukfederation.org.uk', the InCommon or UK Access Management Federation metadata aggregate, respectively, will be used instead, and additional validation checks will happen (including validating that the metadata has been properly signed with the appropriate key). - idpentityid The SAML IdP's entity ID - loginurl The SAML service's SSO target URL - logouturl [Optional] The SAML service's SLO target URL - certificatefingerprint The SAML service's certificate fingerprint. - identifierformat The SAML service's identifier format. Must be one of: - urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress - urn:oasis:names:tc:SAML:2.0:nameid-format:entity - urn:oasis:names:tc:SAML:2.0:nameid-format:kerberos - urn:oasis:names:tc:SAML:2.0:nameid-format:persistent - urn:oasis:names:tc:SAML:2.0:nameid-format:transient - urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified - urn:oasis:names:tc:SAML:1.1:nameid-format:WindowsDomainQualifiedName - urn:oasis:names:tc:SAML:1.1:nameid-format:X509SubjectName - requestedauthncontext [Optional] The SAML AuthnContext - sigalg [Optional] If set, +AuthnRequest+, +LogoutRequest+, and +LogoutResponse+ messages are signed with the corresponding algorithm. Supported algorithms are: - {http://www.w3.org/2000/09/xmldsigrsa-sha1} - {http://www.w3.org/2001/04/xmldsig-morersa-sha256} RSA-SHA1 and RSA-SHA256 are acceptable aliases. - federatedattributes [Optional] See FederatedAttributesConfig. Any value is allowed for the provider attribute names.
POST /v1/accounts/{account_id}/authentication_providers - Destructive
Update authentication provider
Update an authentication provider using the same options as the {api:AuthenticationProvidersControllercreate Add authentication provider} endpoint. You cannot update an existing provider to a new authentication type.
PUT /v1/accounts/{account_id}/authentication_providers/{id} - Destructive
Delete authentication provider
Delete the config
DELETE /v1/accounts/{account_id}/authentication_providers/{id} - Destructive
Restore a deleted authentication provider
Restore an authentication provider back to active that was previously deleted. Only available to admins who can manageauthenticationprovider for given root account.
PUT /v1/accounts/{account_id}/authentication_providers/{id}/restore - Destructive
Update account auth settings
For various cases of mixed SSO configurations, you may need to set some configuration at the account level to handle the particulars of your setup. This endpoint accepts a PUT request to set several possible account settings. All setting are optional on each request, any that are not provided at all are simply retained as is. Any that provide the key but a null-ish value (blank string, null, undefined) will be UN-set. You can list the current state of each setting with "showssosettings"
PUT /v1/accounts/{account_id}/sso_settings - Destructive
Force password reset
Enqueues a job to set the mustresetpassword flag on all active Canvas login pseudonyms for the account. Affected users will be required to change their password on next login. Only available for accounts that have Canvas authentication enabled.
POST /v1/accounts/{account_id}/authentication_providers/force_password_reset
Authentications Log
- Read
Query by login.
List authentication events for a given login.
GET /v1/audit/authentication/logins/{login_id} - Read
Query by account.
List authentication events for a given account.
GET /v1/audit/authentication/accounts/{account_id} - Read
Query by user.
List authentication events for a given user.
GET /v1/audit/authentication/users/{user_id}
Blackout Dates
- Read
List blackout dates
Returns the list of blackout dates for the current context.
GET /v1/courses/{course_id}/blackout_dates - Read
List blackout dates
Returns the list of blackout dates for the current context.
GET /v1/accounts/{account_id}/blackout_dates - Read
Get a single blackout date
Returns the blackout date with the given id.
GET /v1/courses/{course_id}/blackout_dates/{id} - Read
Get a single blackout date
Returns the blackout date with the given id.
GET /v1/accounts/{account_id}/blackout_dates/{id} - Read
New Blackout Date
Initialize an unsaved Blackout Date for the given context.
GET /v1/courses/{course_id}/blackout_dates/new - Read
New Blackout Date
Initialize an unsaved Blackout Date for the given context.
GET /v1/accounts/{account_id}/blackout_dates/new - Write
Create Blackout Date
Create a blackout date for the given context.
POST /v1/courses/{course_id}/blackout_dates - Write
Create Blackout Date
Create a blackout date for the given context.
POST /v1/accounts/{account_id}/blackout_dates - Destructive
Update Blackout Date
Update a blackout date for the given context.
PUT /v1/courses/{course_id}/blackout_dates/{id} - Destructive
Update Blackout Date
Update a blackout date for the given context.
PUT /v1/accounts/{account_id}/blackout_dates/{id} - Destructive
Delete Blackout Date
Delete a blackout date for the given context.
DELETE /v1/courses/{course_id}/blackout_dates/{id} - Destructive
Delete Blackout Date
Delete a blackout date for the given context.
DELETE /v1/accounts/{account_id}/blackout_dates/{id} - Destructive
Update a list of Blackout Dates
Create, update, and delete blackout dates to sync the db with the incoming data.
PUT /v1/courses/{course_id}/blackout_dates
BlockEditorTemplate
- Read
List block templates
A list of the block templates available to the current user.
GET /v1/courses/{course_id}/block_editor_templates
Blueprint Courses
- Read
Get blueprint information
Using 'default' as the templateid should suffice for the current implmentation (as there should be only one template per course). However, using specific template ids may become necessary in the future
GET /v1/courses/{course_id}/blueprint_templates/{template_id} - Read
Get associated course information
Returns a list of courses that are configured to receive updates from this blueprint
GET /v1/courses/{course_id}/blueprint_templates/{template_id}/associated_courses - Read
Get unsynced changes
Retrieve a list of learning objects that have changed since the last blueprint sync operation. If no syncs have been completed, a ChangeRecord with a changetype of +initialsync+ is returned.
GET /v1/courses/{course_id}/blueprint_templates/{template_id}/unsynced_changes - Read
List blueprint migrations
Shows a paginated list of migrations for the template, starting with the most recent. This endpoint can be called on a blueprint course. See also {api:MasterCourses::MasterTemplatesControllerimportsindex the associated course side}.
GET /v1/courses/{course_id}/blueprint_templates/{template_id}/migrations - Read
Show a blueprint migration
Shows the status of a migration. This endpoint can be called on a blueprint course. See also {api:MasterCourses::MasterTemplatesControllerimportsshow the associated course side}.
GET /v1/courses/{course_id}/blueprint_templates/{template_id}/migrations/{id} - Read
Get migration details
Show the changes that were propagated in a blueprint migration. This endpoint can be called on a blueprint course. See also {api:MasterCourses::MasterTemplatesControllerimportdetails the associated course side}.
GET /v1/courses/{course_id}/blueprint_templates/{template_id}/migrations/{id}/details - Read
List blueprint subscriptions
Returns a list of blueprint subscriptions for the given course. (Currently a course may have no more than one.)
GET /v1/courses/{course_id}/blueprint_subscriptions - Read
List blueprint imports
Shows a paginated list of migrations imported into a course associated with a blueprint, starting with the most recent. See also {api:MasterCourses::MasterTemplatesControllermigrationsindex the blueprint course side}. Use 'default' as the subscriptionid to use the currently active blueprint subscription.
GET /v1/courses/{course_id}/blueprint_subscriptions/{subscription_id}/migrations - Read
Show a blueprint import
Shows the status of an import into a course associated with a blueprint. See also {api:MasterCourses::MasterTemplatesControllermigrationsshow the blueprint course side}.
GET /v1/courses/{course_id}/blueprint_subscriptions/{subscription_id}/migrations/{id} - Read
Get import details
Show the changes that were propagated to a course associated with a blueprint. See also {api:MasterCourses::MasterTemplatesControllermigrationdetails the blueprint course side}.
GET /v1/courses/{course_id}/blueprint_subscriptions/{subscription_id}/migrations/{id}/details - Write
Begin a migration to push to associated courses
Begins a migration to push recently updated content to all associated courses. Only one migration can be running at a time.
POST /v1/courses/{course_id}/blueprint_templates/{template_id}/migrations - Destructive
Update associated courses
Send a list of course ids to add or remove new associations for the template. Cannot add courses that do not belong to the blueprint course's account. Also cannot add other blueprint courses or courses that already have an association with another blueprint course. After associating new courses, {api:MasterCourses::MasterTemplatesControllerqueuemigration start a sync} to populate their contents from the blueprint.
PUT /v1/courses/{course_id}/blueprint_templates/{template_id}/update_associations - Destructive
Set or remove restrictions on a blueprint course object
If a blueprint course object is restricted, editing will be limited for copies in associated courses.
PUT /v1/courses/{course_id}/blueprint_templates/{template_id}/restrict_item
Bookmarks
- Read
List bookmarks
Returns the paginated list of bookmarks.
GET /v1/users/self/bookmarks - Read
Get bookmark
Returns the details for a bookmark.
GET /v1/users/self/bookmarks/{id} - Write
Create bookmark
Creates a bookmark.
POST /v1/users/self/bookmarks - Destructive
Update bookmark
Updates a bookmark
PUT /v1/users/self/bookmarks/{id} - Destructive
Delete bookmark
Deletes a bookmark
DELETE /v1/users/self/bookmarks/{id}
Brand Configs
- Read
Get the brand config variables that should be used for this domain
Will redirect to a static json file that has all of the brand variables used by this account. Even though this is a redirect, do not store the redirected url since if the account makes any changes it will redirect to a new url. Needs no authentication.
GET /v1/brand_variables - Read
Get the brand config variables for a sub-account or course
Will redirect to a static json file that has all of the brand variables used by the provided context. Even though this is a redirect, do not store the redirected url since if the sub-account makes any changes it will redirect to a new url.
GET /v1/accounts/{account_id}/brand_variables - Read
Get the brand config variables for a sub-account or course
Will redirect to a static json file that has all of the brand variables used by the provided context. Even though this is a redirect, do not store the redirected url since if the sub-account makes any changes it will redirect to a new url.
GET /v1/courses/{course_id}/brand_variables
Calendar Events
- Read
List calendar events
Retrieve the paginated list of calendar events or assignments for the current user
GET /v1/calendar_events - Read
List calendar events for a user
Retrieve the paginated list of calendar events or assignments for the specified user. To view calendar events for a user other than yourself, you must either be an observer of that user or an administrator.
GET /v1/users/{user_id}/calendar_events - Read
Get a single calendar event or assignment
Returns detailed information about a specific calendar event or assignment.
GET /v1/calendar_events/{id} - Read
Get course timetable
Returns the last timetable set by the {api:CalendarEventsApiControllersetcoursetimetable Set a course timetable} endpoint
GET /v1/courses/{course_id}/calendar_events/timetable - Write
Create a calendar event
Create and return a new calendar event
POST /v1/calendar_events - Write
Save enabled account calendars
Creates and updates the enabledaccountcalendars and markfeatureasseen user preferences
POST /v1/calendar_events/save_enabled_account_calendars - Write
Set a course timetable
Creates and updates "timetable" events for a course. Can automaticaly generate a series of calendar events based on simple schedules (e.g. "Monday and Wednesday at 2:00pm" ) Existing timetable events for the course and course sections will be updated if they still are part of the timetable. Otherwise, they will be deleted.
POST /v1/courses/{course_id}/calendar_events/timetable - Write
Create or update events directly for a course timetable
Creates and updates "timetable" events for a course or course section. Similar to {api:CalendarEventsApiControllersetcoursetimetable setting a course timetable}, but instead of generating a list of events based on a timetable schedule, this endpoint expects a complete list of events.
POST /v1/courses/{course_id}/calendar_events/timetable_events - Destructive
Reserve a time slot
Reserves a particular time slot and return the new reservation
POST /v1/calendar_events/{id}/reservations - Destructive
Reserve a time slot
Reserves a particular time slot and return the new reservation
POST /v1/calendar_events/{id}/reservations/{participant_id} - Destructive
Update a calendar event
Update and return a calendar event
PUT /v1/calendar_events/{id} - Destructive
Delete a calendar event
Delete an event from the calendar and return the deleted event
DELETE /v1/calendar_events/{id}
Canvas Career Experiences
- Read
Check if Canvas Career is enabled
Returns whether the root account has Canvas Career (Horizon) enabled in at least one subaccount.
GET /v1/career/enabled - Read
Get current and available experiences
Returns the current user's active experience and available experiences they can switch to.
GET /v1/career/experience_summary - Write
Switch experience
Switch the current user's active experience to the specified one.
POST /v1/career/switch_experience - Write
Switch role
Switch the current user's Career role. Every role is a Career role, so this also sets the user's preferred experience to career.
POST /v1/career/switch_role
Canvas Career User Context
- Read
Get career user context
Returns consolidated user context data for Journey, combining account permissions, career experience info, enrollment types, admin roles, and site admin status in a single response.
GET /v1/career/user_context
Cohorts
- Read
Get a cohort
Fetch one cohort by id. A soft-deleted cohort is still returned, with workflowstate "deleted".
GET /v1/accounts/{account_id}/cohorts/{cohort_id}
Collaborations
- Read
List collaborations
A paginated list of collaborations the current user has access to in the context of the course provided in the url. NOTE: this only returns ExternalToolCollaboration type collaborations. curl https:// /api/v1/courses/1/collaborations/
GET /v1/courses/{course_id}/collaborations - Read
List collaborations
A paginated list of collaborations the current user has access to in the context of the course provided in the url. NOTE: this only returns ExternalToolCollaboration type collaborations. curl https:// /api/v1/courses/1/collaborations/
GET /v1/groups/{group_id}/collaborations - Read
List members of a collaboration.
A paginated list of the collaborators of a given collaboration
GET /v1/collaborations/{id}/members - Read
List potential members
A paginated list of the users who can potentially be added to a collaboration in the given context. For courses, this consists of all enrolled users. For groups, it is comprised of the group members plus the admins of the course containing the group.
GET /v1/courses/{course_id}/potential_collaborators - Read
List potential members
A paginated list of the users who can potentially be added to a collaboration in the given context. For courses, this consists of all enrolled users. For groups, it is comprised of the group members plus the admins of the course containing the group.
GET /v1/groups/{group_id}/potential_collaborators
CommMessages
- Read
List of CommMessages for a user
Retrieve a paginated list of messages sent to a user.
GET /v1/comm_messages
Communication Channels
- Read
List user communication channels
Returns a paginated list of communication channels for the specified user, sorted by position.
GET /v1/users/{user_id}/communication_channels - Write
Create a communication channel
Creates a new communication channel for the specified user.
POST /v1/users/{user_id}/communication_channels - Destructive
Delete a communication channel
Delete an existing communication channel.
DELETE /v1/users/{user_id}/communication_channels/{id} - Destructive
Delete a communication channel
Delete an existing communication channel.
DELETE /v1/users/{user_id}/communication_channels/{type}/{address} - Destructive
Delete a push notification endpoint
Delete a push notification endpoint
DELETE /v1/users/self/communication_channels/push
Conferences
- Read
List conferences
Retrieve the paginated list of conferences for this context This API returns a JSON object containing the list of conferences, the key for the list of conferences is "conferences"
GET /v1/courses/{course_id}/conferences - Read
List conferences
Retrieve the paginated list of conferences for this context This API returns a JSON object containing the list of conferences, the key for the list of conferences is "conferences"
GET /v1/groups/{group_id}/conferences - Read
List conferences for the current user
Retrieve the paginated list of conferences for all courses and groups the current user belongs to This API returns a JSON object containing the list of conferences. The key for the list of conferences is "conferences".
GET /v1/conferences
Content Exports
- Read
List content exports
A paginated list of the past and pending content export jobs for a course, group, or user. Exports are returned newest first.
GET /v1/courses/{course_id}/content_exports - Read
List content exports
A paginated list of the past and pending content export jobs for a course, group, or user. Exports are returned newest first.
GET /v1/groups/{group_id}/content_exports - Read
List content exports
A paginated list of the past and pending content export jobs for a course, group, or user. Exports are returned newest first.
GET /v1/users/{user_id}/content_exports - Read
Show content export
Get information about a single content export.
GET /v1/courses/{course_id}/content_exports/{id} - Read
Show content export
Get information about a single content export.
GET /v1/groups/{group_id}/content_exports/{id} - Read
Show content export
Get information about a single content export.
GET /v1/users/{user_id}/content_exports/{id} - Write
Export content
Begin a content export job for a course, group, or user. You can use the {api:ProgressControllershow Progress API} to track the progress of the export. The migration's progress is linked to with the progressurl value. When the export completes, use the {api:ContentExportsApiControllershow Show content export} endpoint to retrieve a download URL for the exported content.
POST /v1/courses/{course_id}/content_exports - Write
Export content
Begin a content export job for a course, group, or user. You can use the {api:ProgressControllershow Progress API} to track the progress of the export. The migration's progress is linked to with the progressurl value. When the export completes, use the {api:ContentExportsApiControllershow Show content export} endpoint to retrieve a download URL for the exported content.
POST /v1/groups/{group_id}/content_exports - Write
Export content
Begin a content export job for a course, group, or user. You can use the {api:ProgressControllershow Progress API} to track the progress of the export. The migration's progress is linked to with the progressurl value. When the export completes, use the {api:ContentExportsApiControllershow Show content export} endpoint to retrieve a download URL for the exported content.
POST /v1/users/{user_id}/content_exports
Content Migrations
- Read
List migration issues
Returns paginated migration issues
GET /v1/accounts/{account_id}/content_migrations/{content_migration_id}/migration_issues - Read
List migration issues
Returns paginated migration issues
GET /v1/courses/{course_id}/content_migrations/{content_migration_id}/migration_issues - Read
List migration issues
Returns paginated migration issues
GET /v1/groups/{group_id}/content_migrations/{content_migration_id}/migration_issues - Read
List migration issues
Returns paginated migration issues
GET /v1/users/{user_id}/content_migrations/{content_migration_id}/migration_issues - Read
Get a migration issue
Returns data on an individual migration issue
GET /v1/accounts/{account_id}/content_migrations/{content_migration_id}/migration_issues/{id} - Read
Get a migration issue
Returns data on an individual migration issue
GET /v1/courses/{course_id}/content_migrations/{content_migration_id}/migration_issues/{id} - Read
Get a migration issue
Returns data on an individual migration issue
GET /v1/groups/{group_id}/content_migrations/{content_migration_id}/migration_issues/{id} - Read
Get a migration issue
Returns data on an individual migration issue
GET /v1/users/{user_id}/content_migrations/{content_migration_id}/migration_issues/{id} - Read
List content migrations
Returns paginated content migrations
GET /v1/accounts/{account_id}/content_migrations - Read
List content migrations
Returns paginated content migrations
GET /v1/courses/{course_id}/content_migrations - Read
List content migrations
Returns paginated content migrations
GET /v1/groups/{group_id}/content_migrations - Read
List content migrations
Returns paginated content migrations
GET /v1/users/{user_id}/content_migrations - Read
Get a content migration
Returns data on an individual content migration
GET /v1/accounts/{account_id}/content_migrations/{id} - Read
Get a content migration
Returns data on an individual content migration
GET /v1/courses/{course_id}/content_migrations/{id} - Read
Get a content migration
Returns data on an individual content migration
GET /v1/groups/{group_id}/content_migrations/{id} - Read
Get a content migration
Returns data on an individual content migration
GET /v1/users/{user_id}/content_migrations/{id} - Read
List Migration Systems
Lists the currently available migration types. These values may change.
GET /v1/accounts/{account_id}/content_migrations/migrators - Read
List Migration Systems
Lists the currently available migration types. These values may change.
GET /v1/courses/{course_id}/content_migrations/migrators - Read
List Migration Systems
Lists the currently available migration types. These values may change.
GET /v1/groups/{group_id}/content_migrations/migrators - Read
List Migration Systems
Lists the currently available migration types. These values may change.
GET /v1/users/{user_id}/content_migrations/migrators - Read
List items for selective import
Enumerates the content available for selective import in a tree structure. Each node provides a +property+ copy argument that can be supplied to the {api:ContentMigrationsControllerupdate Update endpoint} to selectively copy the content associated with that tree node and its children. Each node may also provide a +subitemsurl+ or an array of +subitems+ which you can use to obtain copy parameters for a subset of the resources in a given node. If no +type+ is sent you will get a list of the top-level sections in the content. It will look something like this: [{ "type": "coursesettings", "property": "copy[allcoursesettings]", "title": "Course Settings" }, { "type": "contextmodules", "property": "copy[allcontextmodules]", "title": "Modules", "count": 5, "subitemsurl": "http://example.com/api/v1/courses/22/contentmigrations/77/selectivedata?type=contextmodules" }, { "type": "assignments", "property": "copy[allassignments]", "title": "Assignments", "count": 2, "subitemsurl": "http://localhost:3000/api/v1/courses/22/contentmigrations/77/selectivedata?type=assignments" }] When a +type+ is provided, nodes may be further divided via +subitems+. For example, using +type=assignments+ results in a node for each assignment group and a subitem for each assignment, like this: [{ "type": "assignmentgroups", "title": "An Assignment Group", "property": "copy[assignmentgroups][idi855cf145e5acc7435e1bf1c6e2126e5f]", "subitems": [{ "type": "assignments", "title": "Assignment 1", "property": "copy[assignments][idi2102a7fa93b29226774949298626719d]" }, { "type": "assignments", "title": "Assignment 2", "property": "copy[assignments][idi310cba275dc3f4aa8a3306bbbe380979]" }] }] To import the items corresponding to a particular tree node, use the +property+ as a parameter to the {api:ContentMigrationsControllerupdate Update endpoint} and assign a value of 1, for example: copy[assignments][idi310cba275dc3f4aa8a3306bbbe380979]=1 You can include multiple copy parameters to selectively import multiple items or groups of items.
GET /v1/accounts/{account_id}/content_migrations/{id}/selective_data - Read
List items for selective import
Enumerates the content available for selective import in a tree structure. Each node provides a +property+ copy argument that can be supplied to the {api:ContentMigrationsControllerupdate Update endpoint} to selectively copy the content associated with that tree node and its children. Each node may also provide a +subitemsurl+ or an array of +subitems+ which you can use to obtain copy parameters for a subset of the resources in a given node. If no +type+ is sent you will get a list of the top-level sections in the content. It will look something like this: [{ "type": "coursesettings", "property": "copy[allcoursesettings]", "title": "Course Settings" }, { "type": "contextmodules", "property": "copy[allcontextmodules]", "title": "Modules", "count": 5, "subitemsurl": "http://example.com/api/v1/courses/22/contentmigrations/77/selectivedata?type=contextmodules" }, { "type": "assignments", "property": "copy[allassignments]", "title": "Assignments", "count": 2, "subitemsurl": "http://localhost:3000/api/v1/courses/22/contentmigrations/77/selectivedata?type=assignments" }] When a +type+ is provided, nodes may be further divided via +subitems+. For example, using +type=assignments+ results in a node for each assignment group and a subitem for each assignment, like this: [{ "type": "assignmentgroups", "title": "An Assignment Group", "property": "copy[assignmentgroups][idi855cf145e5acc7435e1bf1c6e2126e5f]", "subitems": [{ "type": "assignments", "title": "Assignment 1", "property": "copy[assignments][idi2102a7fa93b29226774949298626719d]" }, { "type": "assignments", "title": "Assignment 2", "property": "copy[assignments][idi310cba275dc3f4aa8a3306bbbe380979]" }] }] To import the items corresponding to a particular tree node, use the +property+ as a parameter to the {api:ContentMigrationsControllerupdate Update endpoint} and assign a value of 1, for example: copy[assignments][idi310cba275dc3f4aa8a3306bbbe380979]=1 You can include multiple copy parameters to selectively import multiple items or groups of items.
GET /v1/courses/{course_id}/content_migrations/{id}/selective_data - Read
List items for selective import
Enumerates the content available for selective import in a tree structure. Each node provides a +property+ copy argument that can be supplied to the {api:ContentMigrationsControllerupdate Update endpoint} to selectively copy the content associated with that tree node and its children. Each node may also provide a +subitemsurl+ or an array of +subitems+ which you can use to obtain copy parameters for a subset of the resources in a given node. If no +type+ is sent you will get a list of the top-level sections in the content. It will look something like this: [{ "type": "coursesettings", "property": "copy[allcoursesettings]", "title": "Course Settings" }, { "type": "contextmodules", "property": "copy[allcontextmodules]", "title": "Modules", "count": 5, "subitemsurl": "http://example.com/api/v1/courses/22/contentmigrations/77/selectivedata?type=contextmodules" }, { "type": "assignments", "property": "copy[allassignments]", "title": "Assignments", "count": 2, "subitemsurl": "http://localhost:3000/api/v1/courses/22/contentmigrations/77/selectivedata?type=assignments" }] When a +type+ is provided, nodes may be further divided via +subitems+. For example, using +type=assignments+ results in a node for each assignment group and a subitem for each assignment, like this: [{ "type": "assignmentgroups", "title": "An Assignment Group", "property": "copy[assignmentgroups][idi855cf145e5acc7435e1bf1c6e2126e5f]", "subitems": [{ "type": "assignments", "title": "Assignment 1", "property": "copy[assignments][idi2102a7fa93b29226774949298626719d]" }, { "type": "assignments", "title": "Assignment 2", "property": "copy[assignments][idi310cba275dc3f4aa8a3306bbbe380979]" }] }] To import the items corresponding to a particular tree node, use the +property+ as a parameter to the {api:ContentMigrationsControllerupdate Update endpoint} and assign a value of 1, for example: copy[assignments][idi310cba275dc3f4aa8a3306bbbe380979]=1 You can include multiple copy parameters to selectively import multiple items or groups of items.
GET /v1/groups/{group_id}/content_migrations/{id}/selective_data - Read
List items for selective import
Enumerates the content available for selective import in a tree structure. Each node provides a +property+ copy argument that can be supplied to the {api:ContentMigrationsControllerupdate Update endpoint} to selectively copy the content associated with that tree node and its children. Each node may also provide a +subitemsurl+ or an array of +subitems+ which you can use to obtain copy parameters for a subset of the resources in a given node. If no +type+ is sent you will get a list of the top-level sections in the content. It will look something like this: [{ "type": "coursesettings", "property": "copy[allcoursesettings]", "title": "Course Settings" }, { "type": "contextmodules", "property": "copy[allcontextmodules]", "title": "Modules", "count": 5, "subitemsurl": "http://example.com/api/v1/courses/22/contentmigrations/77/selectivedata?type=contextmodules" }, { "type": "assignments", "property": "copy[allassignments]", "title": "Assignments", "count": 2, "subitemsurl": "http://localhost:3000/api/v1/courses/22/contentmigrations/77/selectivedata?type=assignments" }] When a +type+ is provided, nodes may be further divided via +subitems+. For example, using +type=assignments+ results in a node for each assignment group and a subitem for each assignment, like this: [{ "type": "assignmentgroups", "title": "An Assignment Group", "property": "copy[assignmentgroups][idi855cf145e5acc7435e1bf1c6e2126e5f]", "subitems": [{ "type": "assignments", "title": "Assignment 1", "property": "copy[assignments][idi2102a7fa93b29226774949298626719d]" }, { "type": "assignments", "title": "Assignment 2", "property": "copy[assignments][idi310cba275dc3f4aa8a3306bbbe380979]" }] }] To import the items corresponding to a particular tree node, use the +property+ as a parameter to the {api:ContentMigrationsControllerupdate Update endpoint} and assign a value of 1, for example: copy[assignments][idi310cba275dc3f4aa8a3306bbbe380979]=1 You can include multiple copy parameters to selectively import multiple items or groups of items.
GET /v1/users/{user_id}/content_migrations/{id}/selective_data - Read
Get asset id mapping
Given a complete course copy or blueprint import content migration, return a mapping of asset ids from the source course to the destination course that were copied in this migration or an earlier one with the same course pair and migrationtype (course copy or blueprint). The returned object's keys are asset types as they appear in API URLs (+announcements+, +assignments+, +discussiontopics+, +files+, +moduleitems+, +modules+, +pages+, and +quizzes+). The values are a mapping from id in source course to id in destination course for objects of this type.
GET /v1/courses/{course_id}/content_migrations/{id}/asset_id_mapping - Write
Create a content migration
Create a content migration. If the migration requires a file to be uploaded the actual processing of the file will start once the file upload process is completed. File uploading works as described in the {file:file.fileuploads.html File Upload Documentation} except that the values are set on a preattachment sub-hash. For migrations that don't require a file to be uploaded, like course copy, the processing will begin as soon as the migration is created. You can use the {api:ProgressControllershow Progress API} to track the progress of the migration. The migration's progress is linked to with the progressurl value. The two general workflows are: If no file upload is needed: 1. POST to create 2. Use the {api:ProgressControllershow Progress} specified in progressurl to monitor progress For file uploading: 1. POST to create with file info in preattachment 2. Do {file:file.fileuploads.html file upload processing} using the data in the preattachment data 3. {api:ContentMigrationsControllershow GET} the ContentMigration 4. Use the {api:ProgressControllershow Progress} specified in progressurl to monitor progress (required if doing .zip file upload)
POST /v1/accounts/{account_id}/content_migrations - Write
Create a content migration
Create a content migration. If the migration requires a file to be uploaded the actual processing of the file will start once the file upload process is completed. File uploading works as described in the {file:file.fileuploads.html File Upload Documentation} except that the values are set on a preattachment sub-hash. For migrations that don't require a file to be uploaded, like course copy, the processing will begin as soon as the migration is created. You can use the {api:ProgressControllershow Progress API} to track the progress of the migration. The migration's progress is linked to with the progressurl value. The two general workflows are: If no file upload is needed: 1. POST to create 2. Use the {api:ProgressControllershow Progress} specified in progressurl to monitor progress For file uploading: 1. POST to create with file info in preattachment 2. Do {file:file.fileuploads.html file upload processing} using the data in the preattachment data 3. {api:ContentMigrationsControllershow GET} the ContentMigration 4. Use the {api:ProgressControllershow Progress} specified in progressurl to monitor progress (required if doing .zip file upload)
POST /v1/courses/{course_id}/content_migrations - Write
Create a content migration
Create a content migration. If the migration requires a file to be uploaded the actual processing of the file will start once the file upload process is completed. File uploading works as described in the {file:file.fileuploads.html File Upload Documentation} except that the values are set on a preattachment sub-hash. For migrations that don't require a file to be uploaded, like course copy, the processing will begin as soon as the migration is created. You can use the {api:ProgressControllershow Progress API} to track the progress of the migration. The migration's progress is linked to with the progressurl value. The two general workflows are: If no file upload is needed: 1. POST to create 2. Use the {api:ProgressControllershow Progress} specified in progressurl to monitor progress For file uploading: 1. POST to create with file info in preattachment 2. Do {file:file.fileuploads.html file upload processing} using the data in the preattachment data 3. {api:ContentMigrationsControllershow GET} the ContentMigration 4. Use the {api:ProgressControllershow Progress} specified in progressurl to monitor progress (required if doing .zip file upload)
POST /v1/groups/{group_id}/content_migrations - Write
Create a content migration
Create a content migration. If the migration requires a file to be uploaded the actual processing of the file will start once the file upload process is completed. File uploading works as described in the {file:file.fileuploads.html File Upload Documentation} except that the values are set on a preattachment sub-hash. For migrations that don't require a file to be uploaded, like course copy, the processing will begin as soon as the migration is created. You can use the {api:ProgressControllershow Progress API} to track the progress of the migration. The migration's progress is linked to with the progressurl value. The two general workflows are: If no file upload is needed: 1. POST to create 2. Use the {api:ProgressControllershow Progress} specified in progressurl to monitor progress For file uploading: 1. POST to create with file info in preattachment 2. Do {file:file.fileuploads.html file upload processing} using the data in the preattachment data 3. {api:ContentMigrationsControllershow GET} the ContentMigration 4. Use the {api:ProgressControllershow Progress} specified in progressurl to monitor progress (required if doing .zip file upload)
POST /v1/users/{user_id}/content_migrations - Destructive
Update a migration issue
Update the workflowstate of a migration issue
PUT /v1/accounts/{account_id}/content_migrations/{content_migration_id}/migration_issues/{id} - Destructive
Update a migration issue
Update the workflowstate of a migration issue
PUT /v1/courses/{course_id}/content_migrations/{content_migration_id}/migration_issues/{id} - Destructive
Update a migration issue
Update the workflowstate of a migration issue
PUT /v1/groups/{group_id}/content_migrations/{content_migration_id}/migration_issues/{id} - Destructive
Update a migration issue
Update the workflowstate of a migration issue
PUT /v1/users/{user_id}/content_migrations/{content_migration_id}/migration_issues/{id} - Destructive
Update a content migration
Update a content migration. Takes same arguments as {api:ContentMigrationsControllercreate create} except that you can't change the migration type. However, changing most settings after the migration process has started will not do anything. Generally updating the content migration will be used when there is a file upload problem, or when importing content selectively. If the first upload has a problem you can supply new preattachment values to start the process again.
PUT /v1/accounts/{account_id}/content_migrations/{id} - Destructive
Update a content migration
Update a content migration. Takes same arguments as {api:ContentMigrationsControllercreate create} except that you can't change the migration type. However, changing most settings after the migration process has started will not do anything. Generally updating the content migration will be used when there is a file upload problem, or when importing content selectively. If the first upload has a problem you can supply new preattachment values to start the process again.
PUT /v1/courses/{course_id}/content_migrations/{id} - Destructive
Update a content migration
Update a content migration. Takes same arguments as {api:ContentMigrationsControllercreate create} except that you can't change the migration type. However, changing most settings after the migration process has started will not do anything. Generally updating the content migration will be used when there is a file upload problem, or when importing content selectively. If the first upload has a problem you can supply new preattachment values to start the process again.
PUT /v1/groups/{group_id}/content_migrations/{id} - Destructive
Update a content migration
Update a content migration. Takes same arguments as {api:ContentMigrationsControllercreate create} except that you can't change the migration type. However, changing most settings after the migration process has started will not do anything. Generally updating the content migration will be used when there is a file upload problem, or when importing content selectively. If the first upload has a problem you can supply new preattachment values to start the process again.
PUT /v1/users/{user_id}/content_migrations/{id}
Content Security Policy Settings
- Read
Get current settings for account or course
Update multiple modules in an account.
GET /v1/courses/{course_id}/csp_settings - Read
Get current settings for account or course
Update multiple modules in an account.
GET /v1/accounts/{account_id}/csp_settings - Write
Add an allowed domain to account
Adds an allowed domain for the current account. Note: this will not take effect unless CSP is explicitly enabled on this account.
POST /v1/accounts/{account_id}/csp_settings/domains - Write
Add multiple allowed domains to an account
Adds multiple allowed domains for the current account. Note: this will not take effect unless CSP is explicitly enabled on this account.
POST /v1/accounts/{account_id}/csp_settings/domains/batch_create - Destructive
Enable, disable, or clear explicit CSP setting
Either explicitly sets CSP to be on or off for courses and sub-accounts, or clear the explicit settings to default to those set by a parent account Note: If "inherited" and "settingslocked" are both true for this account or course, then the CSP setting cannot be modified.
PUT /v1/courses/{course_id}/csp_settings - Destructive
Enable, disable, or clear explicit CSP setting
Either explicitly sets CSP to be on or off for courses and sub-accounts, or clear the explicit settings to default to those set by a parent account Note: If "inherited" and "settingslocked" are both true for this account or course, then the CSP setting cannot be modified.
PUT /v1/accounts/{account_id}/csp_settings - Destructive
Lock or unlock current CSP settings for sub-accounts and courses
Can only be set if CSP is explicitly enabled or disabled on this account (i.e. "inherited" is false).
PUT /v1/accounts/{account_id}/csp_settings/lock - Destructive
Remove a domain from account
Removes an allowed domain from the current account.
DELETE /v1/accounts/{account_id}/csp_settings/domains
Content Shares
Conversations
- Read
List conversations
Returns the paginated list of conversations for the current user, most recent ones first. "uuid:W9GQIcdoDTqwX8mxIunDQQVL6WZTaGmpa5xovmCB", or "course456". For users, you can use either their numeric ID or UUID prefixed with "uuid:". Can be an array (by setting "filter[]") or single value (by setting "filter")
GET /v1/conversations - Read
Get running batches
Returns any currently running conversation batches for the current user. Conversation batches are created when a bulk private message is sent asynchronously (see the mode argument to the {api:ConversationsControllercreate create API action}).
GET /v1/conversations/batches - Read
Get a single conversation
Returns information for a single conversation for the current user. Response includes all fields that are present in the list/index action as well as messages and extended participant information.
GET /v1/conversations/{id} - Read
Find recipients
Deprecated, see the {api:SearchControllerrecipients Find recipients endpoint} in the Search API
GET /v1/conversations/find_recipients - Read
Unread count
Get the number of unread conversations for the current user
GET /v1/conversations/unread_count - Write
Create a conversation
Create a new conversation with one or more recipients. If there is already an existing private conversation with the given recipients, it will be reused. (either numeric IDs or UUIDs prefixed with "uuid:"), or course/group ids prefixed with "course" or "group" respectively, e.g. recipients[]=1&recipients[]=uuid:W9GQIcdoDTqwX8mxIunDQQVL6WZTaGmpa5xovmCBx&recipients[]=course3. If the course/group has over 100 enrollments, 'bulkmessage' and 'groupconversation' must be set to true.
POST /v1/conversations - Write
Mark all as read
Mark all conversations as read.
POST /v1/conversations/mark_all_as_read - Write
Add recipients
Add recipients to an existing group conversation. Response is similar to the GET/show action, except that only includes the latest message (e.g. "joe was added to the conversation by bob")
POST /v1/conversations/{id}/add_recipients - Write
Add a message
Add a message to an existing conversation. Response is similar to the GET/show action, except that only includes the latest message (i.e. what we just sent) An array of user ids. Defaults to all of the current conversation recipients. To explicitly send a message to no other recipients, this array should consist of the logged-in user id. An array of message ids from this conversation to send to recipients of the new message. Recipients who already had a copy of included messages will not be affected.
POST /v1/conversations/{id}/add_message - Destructive
Edit a conversation
Updates attributes for a single conversation.
PUT /v1/conversations/{id} - Destructive
Delete a conversation
Delete this conversation and its messages. Note that this only deletes this user's view of the conversation. Response includes same fields as UPDATE action
DELETE /v1/conversations/{id} - Destructive
Delete a message
Delete messages from this conversation. Note that this only affects this user's view of the conversation. If all messages are deleted, the conversation will be as well (equivalent to DELETE)
POST /v1/conversations/{id}/remove_messages - Destructive
Batch update conversations
Perform a change on a set of conversations. Operates asynchronously; use the {api:ProgressControllershow progress endpoint} to query the status of an operation.
PUT /v1/conversations
Course Audit log
- Read
Query by course.
List course change events for a given course.
GET /v1/audit/course/courses/{course_id} - Read
Query by account.
List course change events for a given account.
GET /v1/audit/course/accounts/{account_id}
Course Pace
- Read
Show a Course pace
Returns a course pace for the course and pace id provided
GET /v1/courses/{course_id}/course_pacing/{id} - Write
Create a Course pace
Creates a new course pace with specified parameters.
POST /v1/courses/{course_id}/course_pacing - Destructive
Update a Course pace
Returns the updated course pace
PUT /v1/courses/{course_id}/course_pacing/{id} - Destructive
Delete a Course pace
Returns the updated course pace
DELETE /v1/courses/{course_id}/course_pacing/{id}
Course Quiz Extensions
- Write
Set extensions for student quiz submissions
Responses 200 OK if the request was successful 403 Forbidden if you are not allowed to extend quizzes for this course
POST /v1/courses/{course_id}/quiz_extensions
Course Reports
- Read
Status of a Report
Returns the status of a report.
GET /v1/courses/{course_id}/reports/{report_type}/{id} - Read
Status of last Report
Returns the status of the last report initiated by the current user.
GET /v1/courses/{course_id}/reports/{report_type} - Write
Start a Report
Generates a report instance for the account. Note that "report" in the request must match one of the available report names.
POST /v1/courses/{course_id}/reports/{report_type}
Courses
- Read
List your courses
Returns the paginated list of active courses for the current user.
GET /v1/courses - Read
List courses for a user
Returns a paginated list of active courses for this user. To view the course list for a user other than yourself, you must be either an observer of that user or an administrator.
GET /v1/users/{user_id}/courses - Read
Get user progress
Return progress information for the user and course You can supply +self+ as the userid to query your own progress in a course. To query another user's progress, you must be a teacher in the course, an administrator, or a linked observer of the user.
GET /v1/courses/{course_id}/users/{user_id}/progress - Read
List students
Returns the paginated list of students enrolled in this course. DEPRECATED: Please use the {api:CoursesControllerusers course users} endpoint and pass "student" as the enrollmenttype.
GET /v1/courses/{course_id}/students - Read
List users in course
Returns the paginated list of users in this course. And optionally the user's enrollments in the course.
GET /v1/courses/{course_id}/users - Read
List users in course
Returns the paginated list of users in this course. And optionally the user's enrollments in the course.
GET /v1/courses/{course_id}/search_users - Read
List recently logged in students
Returns the paginated list of users in this course, ordered by how recently they have logged in. The records include the 'lastlogin' field which contains a timestamp of the last time that user logged into canvas. The querying user must have the 'View usage reports' permission.
GET /v1/courses/{course_id}/recent_students - Read
Get single user
Return information on a single user. Accepts the same include[] parameters as the :users: action, and returns a single user with the same fields as that action.
GET /v1/courses/{course_id}/users/{id} - Read
Preview processed html
Preview html content processed for this course
POST /v1/courses/{course_id}/preview_html - Read
Course activity stream
Returns the current user's course-specific activity stream, paginated. For full documentation, see the API documentation for the user activity stream, in the user api.
GET /v1/courses/{course_id}/activity_stream - Read
Course activity stream summary
Returns a summary of the current user's course-specific activity stream. For full documentation, see the API documentation for the user activity stream summary, in the user api.
GET /v1/courses/{course_id}/activity_stream/summary - Read
Course TODO items
Returns the current user's course-specific todo items. For full documentation, see the API documentation for the user todo items, in the user api.
GET /v1/courses/{course_id}/todo - Read
Get course settings
Returns some of a course's settings.
GET /v1/courses/{course_id}/settings - Read
Return test student for course
Returns information for a test student in this course. Creates a test student if one does not already exist for the course. The caller must have permission to access the course's student view.
GET /v1/courses/{course_id}/student_view_student - Read
Get a single course
Return information on a single course. Accepts the same include[] parameters as the list action plus:
GET /v1/courses/{id} - Read
Get a single course
Return information on a single course. Accepts the same include[] parameters as the list action plus:
GET /v1/accounts/{account_id}/courses/{id} - Read
Get effective due dates
For each assignment in the course, returns each assigned student's ID and their corresponding due date along with some grading period data. Returns a collection with keys representing assignment IDs and values as a collection containing keys representing student IDs and values representing the student's effective dueat, the gradingperiodid of which the dueat falls in, and whether or not the grading period is closed (inclosedgradingperiod) The list of assignment IDs for which effective student due dates are requested. If not provided, all assignments in the course will be used.
GET /v1/courses/{course_id}/effective_due_dates - Read
Permissions
Returns permission information for the calling user in the given course. See also the {api:AccountsControllerpermissions Account} and {api:GroupsControllerpermissions Group} counterparts.
GET /v1/courses/{course_id}/permissions - Read
Get bulk user progress
Returns progress information for all users enrolled in the given course. You must be a user who has permission to view all grades in the course (such as a teacher or administrator).
GET /v1/courses/{course_id}/bulk_user_progress - Read
Get course copy status
DEPRECATED: Please use the {api:ContentMigrationsControllercreate Content Migrations API} Retrieve the status of a course copy
GET /v1/courses/{course_id}/course_copy/{id} - Write
Create a new course
Create a new course
POST /v1/accounts/{account_id}/courses - Write
Upload a file
Upload a file to the course. This API endpoint is the first step in uploading a file to a course. See the {file:file.fileuploads.html File Upload Documentation} for details on the file upload workflow. Only those with the "Manage Files" permission on a course can upload files to the course. By default, this is Teachers, TAs and Designers.
POST /v1/courses/{course_id}/files - Write
Restore course syllabus version
Restore a course's syllabus body to a previously saved version. No other course content is affected. Requires the syllabusversioning feature flag to be enabled on the account, and the caller must have permission to manage course content.
POST /v1/courses/{course_id}/restore/{version_id} - Write
Copy course content
DEPRECATED: Please use the {api:ContentMigrationsControllercreate Content Migrations API} Copies content from one course into another. The default is to copy all course content. You can control specific types to copy by using either the 'except' option or the 'only' option. The response is the same as the course copy status endpoint
POST /v1/courses/{course_id}/course_copy - Destructive
Delete/Conclude a course
Delete or conclude an existing course
DELETE /v1/courses/{id} - Destructive
Update course settings
Can update the following course settings:
PUT /v1/courses/{course_id}/settings - Destructive
Update a course
Update an existing course. Arguments are the same as Coursescreate, with a few exceptions (enrollme). If a user has content management rights, but not full course editing rights, the only attribute editable through this endpoint will be "syllabusbody" If an account has set preventcourseavailabilityeditingbyteachers, a teacher cannot change +course[startat]+, +course[concludeat]+, or +course[restrictenrollmentstocoursedates]+ here.
PUT /v1/courses/{id} - Destructive
Update courses
Update multiple courses in an account. Operates asynchronously; use the {api:ProgressControllershow progress endpoint} to query the status of an operation.
PUT /v1/accounts/{account_id}/courses - Destructive
Reset a course
Deletes the current course, and creates a new equivalent course with no content, but all sections and users moved over.
POST /v1/courses/{course_id}/reset_content - Destructive
Remove quiz migration alert
Remove alert about the limitations of quiz migrations that is displayed to a user in a course you must be logged in to use this endpoint
POST /v1/courses/{id}/dismiss_migration_limitation_message
Custom Gradebook Columns
- Read
List custom gradebook columns
A paginated list of all custom gradebook columns for a course
GET /v1/courses/{course_id}/custom_gradebook_columns - Read
List entries for a column
This does not list entries for students without associated data.
GET /v1/courses/{course_id}/custom_gradebook_columns/{id}/data - Write
Create a custom gradebook column
Create a custom gradebook column
POST /v1/courses/{course_id}/custom_gradebook_columns - Write
Reorder custom columns
Puts the given columns in the specified order 200 OK is returned if successful
POST /v1/courses/{course_id}/custom_gradebook_columns/reorder - Destructive
Update a custom gradebook column
Accepts the same parameters as custom gradebook column creation
PUT /v1/courses/{course_id}/custom_gradebook_columns/{id} - Destructive
Delete a custom gradebook column
Permanently deletes a custom column and its associated data
DELETE /v1/courses/{course_id}/custom_gradebook_columns/{id} - Destructive
Update column data
Set the content of a custom column
PUT /v1/courses/{course_id}/custom_gradebook_columns/{id}/data/{user_id} - Destructive
Bulk update column data
Set the content of custom columns { "columndata": [ { "columnid": examplecolumnid, "userid": examplestudentid, "content": examplecontent }, { "columnid": examplecolumnid, "userid": examplestudentid, "content: examplecontent } ] }
PUT /v1/courses/{course_id}/custom_gradebook_column_data
Developer Key Account Bindings
- Write
Create a Developer Key Account Binding
Create a new Developer Key Account Binding. The developer key specified in the request URL must be available in the requested account or the requested account's account chain. If the binding already exists for the specified account/key combination it will be updated.
POST /v1/accounts/{account_id}/developer_keys/{developer_key_id}/developer_key_account_bindings
Developer Keys
- Read
List Developer Keys
List all developer keys created in the current account.
GET /v1/accounts/{account_id}/developer_keys - Write
Create a Developer Key
Create a new Canvas API key. Creating an LTI 1.3 registration is not supported here and should be done via the LTI Registration API.
POST /v1/accounts/{account_id}/developer_keys - Write
Regenerate Developer Key Secret
Regenerate the secret (apikey) for an existing Canvas API key. This invalidates the existing secret. Any applications using the old secret will stop working. Regenerating a secret for an LTI key is not supported. This endpoint requires the developerkeyregeneratesecret feature flag to be enabled. This feature flag can only be turned on by Site Admins
POST /v1/developer_keys/{id}/regenerate_secret - Destructive
Update a Developer Key
Update an existing Canvas API key. Updating an LTI 1.3 registration is not supported here and should be done via the LTI Registration API.
PUT /v1/developer_keys/{id} - Destructive
Delete a Developer Key
Delete an existing Canvas API key. Deleting an LTI 1.3 registration should be done via the LTI Registration API.
DELETE /v1/developer_keys/{id}
Discovery Pages
- Read
Get Discovery Page
Get the discovery page configuration for the domain root account. Returns labels exactly as stored, with no HTML-escaping applied. Callers are responsible for escaping on render (the admin React UI does this via JSX auto-escaping).
GET /v1/discovery_pages - Write
Generate Discovery Page Preview Token
Returns a short-lived RS256-signed JWT containing the discovery page button link configuration, suitable for sending to the identity service preview iframe via postMessage. A discoverypage configuration must be provided in the request body. Omitting it returns a 400 Bad Request.
POST /v1/discovery_pages/token - Destructive
Update Discovery Page
Update or create the discovery page configuration for the domain root account. This is a full replacement - provide the complete configuration including primary, secondary, and active fields. Any fields omitted will be removed.
PUT /v1/discovery_pages
Discussion Topics
- Read
List discussion topics
Returns the paginated list of discussion topics for this course or group.
GET /v1/courses/{course_id}/discussion_topics - Read
List discussion topics
Returns the paginated list of discussion topics for this course or group.
GET /v1/groups/{group_id}/discussion_topics - Read
Get a single topic
Returns data on an individual discussion topic. See the List action for the response formatting.
GET /v1/courses/{course_id}/discussion_topics/{topic_id} - Read
Get a single topic
Returns data on an individual discussion topic. See the List action for the response formatting.
GET /v1/groups/{group_id}/discussion_topics/{topic_id} - Read
Find Last Summary
Returns: (1) last userInput (what current user had keyed in to produce the last discussion summary), (2) last discussion summary generated by the current user for current discussion topic, based on userInput, (3) and some usage information.
GET /v1/courses/{course_id}/discussion_topics/{topic_id}/summaries - Read
Find Last Summary
Returns: (1) last userInput (what current user had keyed in to produce the last discussion summary), (2) last discussion summary generated by the current user for current discussion topic, based on userInput, (3) and some usage information.
GET /v1/groups/{group_id}/discussion_topics/{topic_id}/summaries - Read
Get the full topic
Return a cached structure of the discussion topic, containing all entries, their authors, and their message bodies. May require (depending on the topic) that the user has posted in the topic. If it is required, and the user has not posted, will respond with a 403 Forbidden status and the body 'requireinitialpost'. In some rare situations, this cached structure may not be available yet. In that case, the server will respond with a 503 error, and the caller should try again soon. The response is an object containing the following keys: "participants": A list of summary information on users who have posted to the discussion. Each value is an object containing their id, displayname, and avatarurl. "unreadentries": A list of entry ids that are unread by the current user. this implies that any entry not in this list is read. "entryratings": A map of entry ids to ratings by the current user. Entries not in this list have no rating. Only populated if rating is enabled. "forcedentries": A list of entry ids that have forcedreadstate set to true. This flag is meant to indicate the entry's readstate has been manually set to 'unread' by the user, so the entry should not be automatically marked as read. "view": A threaded view of all the entries in the discussion, containing the id, userid, and message. "newentries": Because this view is eventually consistent, it's possible that newly created or updated entries won't yet be reflected in the view. If the application wants to also get a flat list of all entries not yet reflected in the view, pass includenewentries=1 to the request and this array of entries will be returned. These entries are returned in a flat array, in ascending createdat order.
GET /v1/courses/{course_id}/discussion_topics/{topic_id}/view - Read
Get the full topic
Return a cached structure of the discussion topic, containing all entries, their authors, and their message bodies. May require (depending on the topic) that the user has posted in the topic. If it is required, and the user has not posted, will respond with a 403 Forbidden status and the body 'requireinitialpost'. In some rare situations, this cached structure may not be available yet. In that case, the server will respond with a 503 error, and the caller should try again soon. The response is an object containing the following keys: "participants": A list of summary information on users who have posted to the discussion. Each value is an object containing their id, displayname, and avatarurl. "unreadentries": A list of entry ids that are unread by the current user. this implies that any entry not in this list is read. "entryratings": A map of entry ids to ratings by the current user. Entries not in this list have no rating. Only populated if rating is enabled. "forcedentries": A list of entry ids that have forcedreadstate set to true. This flag is meant to indicate the entry's readstate has been manually set to 'unread' by the user, so the entry should not be automatically marked as read. "view": A threaded view of all the entries in the discussion, containing the id, userid, and message. "newentries": Because this view is eventually consistent, it's possible that newly created or updated entries won't yet be reflected in the view. If the application wants to also get a flat list of all entries not yet reflected in the view, pass includenewentries=1 to the request and this array of entries will be returned. These entries are returned in a flat array, in ascending createdat order.
GET /v1/groups/{group_id}/discussion_topics/{topic_id}/view - Read
List topic entries
Retrieve the (paginated) top-level entries in a discussion topic. May require (depending on the topic) that the user has posted in the topic. If it is required, and the user has not posted, will respond with a 403 Forbidden status and the body 'requireinitialpost'. Will include the 10 most recent replies, if any, for each entry returned. If the topic is a root topic with children corresponding to groups of a group assignment, entries from those subtopics for which the user belongs to the corresponding group will be returned. Ordering of returned entries is newest-first by posting timestamp (reply activity is ignored).
GET /v1/courses/{course_id}/discussion_topics/{topic_id}/entries - Read
List topic entries
Retrieve the (paginated) top-level entries in a discussion topic. May require (depending on the topic) that the user has posted in the topic. If it is required, and the user has not posted, will respond with a 403 Forbidden status and the body 'requireinitialpost'. Will include the 10 most recent replies, if any, for each entry returned. If the topic is a root topic with children corresponding to groups of a group assignment, entries from those subtopics for which the user belongs to the corresponding group will be returned. Ordering of returned entries is newest-first by posting timestamp (reply activity is ignored).
GET /v1/groups/{group_id}/discussion_topics/{topic_id}/entries - Read
List entry replies
Retrieve the (paginated) replies to a top-level entry in a discussion topic. May require (depending on the topic) that the user has posted in the topic. If it is required, and the user has not posted, will respond with a 403 Forbidden status and the body 'requireinitialpost'. Ordering of returned entries is newest-first by creation timestamp.
GET /v1/courses/{course_id}/discussion_topics/{topic_id}/entries/{entry_id}/replies - Read
List entry replies
Retrieve the (paginated) replies to a top-level entry in a discussion topic. May require (depending on the topic) that the user has posted in the topic. If it is required, and the user has not posted, will respond with a 403 Forbidden status and the body 'requireinitialpost'. Ordering of returned entries is newest-first by creation timestamp.
GET /v1/groups/{group_id}/discussion_topics/{topic_id}/entries/{entry_id}/replies - Read
List entries
Retrieve a paginated list of discussion entries, given a list of ids. May require (depending on the topic) that the user has posted in the topic. If it is required, and the user has not posted, will respond with a 403 Forbidden status and the body 'requireinitialpost'.
GET /v1/courses/{course_id}/discussion_topics/{topic_id}/entry_list - Read
List entries
Retrieve a paginated list of discussion entries, given a list of ids. May require (depending on the topic) that the user has posted in the topic. If it is required, and the user has not posted, will respond with a 403 Forbidden status and the body 'requireinitialpost'.
GET /v1/groups/{group_id}/discussion_topics/{topic_id}/entry_list - Write
Create a new discussion topic
Create an new discussion topic for the course or group.
POST /v1/courses/{course_id}/discussion_topics - Write
Create a new discussion topic
Create an new discussion topic for the course or group.
POST /v1/groups/{group_id}/discussion_topics - Write
Reorder pinned topics
Puts the pinned discussion topics in the specified order. All pinned topics should be included.
POST /v1/courses/{course_id}/discussion_topics/reorder - Write
Reorder pinned topics
Puts the pinned discussion topics in the specified order. All pinned topics should be included.
POST /v1/groups/{group_id}/discussion_topics/reorder - Write
Find or Create Summary
Generates a summary for a discussion topic. Returns the summary text and usage information.
POST /v1/courses/{course_id}/discussion_topics/{topic_id}/summaries - Write
Find or Create Summary
Generates a summary for a discussion topic. Returns the summary text and usage information.
POST /v1/groups/{group_id}/discussion_topics/{topic_id}/summaries - Write
Summary Feedback
Persists feedback on a discussion topic summary.
POST /v1/courses/{course_id}/discussion_topics/{topic_id}/summaries/{summary_id}/feedback - Write
Summary Feedback
Persists feedback on a discussion topic summary.
POST /v1/groups/{group_id}/discussion_topics/{topic_id}/summaries/{summary_id}/feedback - Write
Post an entry
Create a new entry in a discussion topic. Returns a json representation of the created entry (see documentation for 'entries' method) on success.
POST /v1/courses/{course_id}/discussion_topics/{topic_id}/entries - Write
Post an entry
Create a new entry in a discussion topic. Returns a json representation of the created entry (see documentation for 'entries' method) on success.
POST /v1/groups/{group_id}/discussion_topics/{topic_id}/entries - Write
Duplicate discussion topic
Duplicate a discussion topic according to context (Course/Group)
POST /v1/courses/{course_id}/discussion_topics/{topic_id}/duplicate - Write
Duplicate discussion topic
Duplicate a discussion topic according to context (Course/Group)
POST /v1/groups/{group_id}/discussion_topics/{topic_id}/duplicate - Write
Post a reply
Add a reply to an entry in a discussion topic. Returns a json representation of the created reply (see documentation for 'replies' method) on success. May require (depending on the topic) that the user has posted in the topic. If it is required, and the user has not posted, will respond with a 403 Forbidden status and the body 'requireinitialpost'.
POST /v1/courses/{course_id}/discussion_topics/{topic_id}/entries/{entry_id}/replies - Write
Post a reply
Add a reply to an entry in a discussion topic. Returns a json representation of the created reply (see documentation for 'replies' method) on success. May require (depending on the topic) that the user has posted in the topic. If it is required, and the user has not posted, will respond with a 403 Forbidden status and the body 'requireinitialpost'.
POST /v1/groups/{group_id}/discussion_topics/{topic_id}/entries/{entry_id}/replies - Write
Rate entry
Rate a discussion entry. On success, the response will be 204 No Content with an empty body.
POST /v1/courses/{course_id}/discussion_topics/{topic_id}/entries/{entry_id}/rating - Write
Rate entry
Rate a discussion entry. On success, the response will be 204 No Content with an empty body.
POST /v1/groups/{group_id}/discussion_topics/{topic_id}/entries/{entry_id}/rating - Destructive
Update a topic
Update an existing discussion topic for the course or group.
PUT /v1/courses/{course_id}/discussion_topics/{topic_id} - Destructive
Update a topic
Update an existing discussion topic for the course or group.
PUT /v1/groups/{group_id}/discussion_topics/{topic_id} - Destructive
Delete a topic
Deletes the discussion topic. This will also delete the assignment, if it's an assignment discussion.
DELETE /v1/courses/{course_id}/discussion_topics/{topic_id} - Destructive
Delete a topic
Deletes the discussion topic. This will also delete the assignment, if it's an assignment discussion.
DELETE /v1/groups/{group_id}/discussion_topics/{topic_id} - Destructive
Update an entry
Update an existing discussion entry. The entry must have been created by the current user, or the current user must have admin rights to the discussion. If the edit is not allowed, a 401 will be returned.
PUT /v1/courses/{course_id}/discussion_topics/{topic_id}/entries/{id} - Destructive
Update an entry
Update an existing discussion entry. The entry must have been created by the current user, or the current user must have admin rights to the discussion. If the edit is not allowed, a 401 will be returned.
PUT /v1/groups/{group_id}/discussion_topics/{topic_id}/entries/{id} - Destructive
Delete an entry
Delete a discussion entry. The entry must have been created by the current user, or the current user must have admin rights to the discussion. If the delete is not allowed, a 401 will be returned. The discussion will be marked deleted, and the userid and message will be cleared out.
DELETE /v1/courses/{course_id}/discussion_topics/{topic_id}/entries/{id} - Destructive
Delete an entry
Delete a discussion entry. The entry must have been created by the current user, or the current user must have admin rights to the discussion. If the delete is not allowed, a 401 will be returned. The discussion will be marked deleted, and the userid and message will be cleared out.
DELETE /v1/groups/{group_id}/discussion_topics/{topic_id}/entries/{id} - Destructive
Disable summary
Deprecated, to remove after VICE-5047 gets merged Disables the summary for a discussion topic.
PUT /v1/courses/{course_id}/discussion_topics/{topic_id}/summaries/disable - Destructive
Disable summary
Deprecated, to remove after VICE-5047 gets merged Disables the summary for a discussion topic.
PUT /v1/groups/{group_id}/discussion_topics/{topic_id}/summaries/disable - Destructive
Mark topic as read
Mark the initial text of the discussion topic as read. No request fields are necessary. On success, the response will be 204 No Content with an empty body.
PUT /v1/courses/{course_id}/discussion_topics/{topic_id}/read - Destructive
Mark topic as read
Mark the initial text of the discussion topic as read. No request fields are necessary. On success, the response will be 204 No Content with an empty body.
PUT /v1/groups/{group_id}/discussion_topics/{topic_id}/read - Destructive
Mark all topic as read
Mark the initial text of all the discussion topics as read in the context. No request fields are necessary. On success, the response will be 204 No Content with an empty body.
PUT /v1/courses/{course_id}/discussion_topics/read_all - Destructive
Mark all topic as read
Mark the initial text of all the discussion topics as read in the context. No request fields are necessary. On success, the response will be 204 No Content with an empty body.
PUT /v1/groups/{group_id}/discussion_topics/read_all - Destructive
Mark topic as unread
Mark the initial text of the discussion topic as unread. No request fields are necessary. On success, the response will be 204 No Content with an empty body.
DELETE /v1/courses/{course_id}/discussion_topics/{topic_id}/read - Destructive
Mark topic as unread
Mark the initial text of the discussion topic as unread. No request fields are necessary. On success, the response will be 204 No Content with an empty body.
DELETE /v1/groups/{group_id}/discussion_topics/{topic_id}/read - Destructive
Mark all entries as read
Mark the discussion topic and all its entries as read. No request fields are necessary. On success, the response will be 204 No Content with an empty body.
PUT /v1/courses/{course_id}/discussion_topics/{topic_id}/read_all - Destructive
Mark all entries as read
Mark the discussion topic and all its entries as read. No request fields are necessary. On success, the response will be 204 No Content with an empty body.
PUT /v1/groups/{group_id}/discussion_topics/{topic_id}/read_all - Destructive
Mark all entries as unread
Mark the discussion topic and all its entries as unread. No request fields are necessary. On success, the response will be 204 No Content with an empty body.
DELETE /v1/courses/{course_id}/discussion_topics/{topic_id}/read_all - Destructive
Mark all entries as unread
Mark the discussion topic and all its entries as unread. No request fields are necessary. On success, the response will be 204 No Content with an empty body.
DELETE /v1/groups/{group_id}/discussion_topics/{topic_id}/read_all - Destructive
Mark entry as read
Mark a discussion entry as read. No request fields are necessary. On success, the response will be 204 No Content with an empty body.
PUT /v1/courses/{course_id}/discussion_topics/{topic_id}/entries/{entry_id}/read - Destructive
Mark entry as read
Mark a discussion entry as read. No request fields are necessary. On success, the response will be 204 No Content with an empty body.
PUT /v1/groups/{group_id}/discussion_topics/{topic_id}/entries/{entry_id}/read - Destructive
Mark entry as unread
Mark a discussion entry as unread. No request fields are necessary. On success, the response will be 204 No Content with an empty body.
DELETE /v1/courses/{course_id}/discussion_topics/{topic_id}/entries/{entry_id}/read - Destructive
Mark entry as unread
Mark a discussion entry as unread. No request fields are necessary. On success, the response will be 204 No Content with an empty body.
DELETE /v1/groups/{group_id}/discussion_topics/{topic_id}/entries/{entry_id}/read - Destructive
Subscribe to a topic
Subscribe to a topic to receive notifications about new entries On success, the response will be 204 No Content with an empty body
PUT /v1/courses/{course_id}/discussion_topics/{topic_id}/subscribed - Destructive
Subscribe to a topic
Subscribe to a topic to receive notifications about new entries On success, the response will be 204 No Content with an empty body
PUT /v1/groups/{group_id}/discussion_topics/{topic_id}/subscribed - Destructive
Unsubscribe from a topic
Unsubscribe from a topic to stop receiving notifications about new entries On success, the response will be 204 No Content with an empty body
DELETE /v1/courses/{course_id}/discussion_topics/{topic_id}/subscribed - Destructive
Unsubscribe from a topic
Unsubscribe from a topic to stop receiving notifications about new entries On success, the response will be 204 No Content with an empty body
DELETE /v1/groups/{group_id}/discussion_topics/{topic_id}/subscribed
Enrollment Terms
- Read
List enrollment terms
An object with a paginated list of all of the terms in the account.
GET /v1/accounts/{account_id}/terms - Read
Retrieve enrollment term
Retrieves the details for an enrollment term in the account. Includes overrides by default.
GET /v1/accounts/{account_id}/terms/{id} - Write
Create enrollment term
Create a new enrollment term for the specified account.
POST /v1/accounts/{account_id}/terms - Destructive
Update enrollment term
Update an existing enrollment term for the specified account.
PUT /v1/accounts/{account_id}/terms/{id} - Destructive
Delete enrollment term
Delete the specified enrollment term.
DELETE /v1/accounts/{account_id}/terms/{id}
Enrollments
- Read
List enrollments
Depending on the URL given, return a paginated list of either (1) all of the enrollments in a course, (2) all of the enrollments in a section or (3) all of a user's enrollments. This includes student, teacher, TA, and observer enrollments. If a user has multiple enrollments in a context (e.g. as a teacher and a student or in multiple course sections), each enrollment will be listed separately. note: Currently, only a root level admin user can return other users' enrollments. A user can, however, return his/her own enrollments. Enrollments scoped to a course context will include inactive states by default if the caller has account admin authorization and the state[] parameter is omitted.
GET /v1/courses/{course_id}/enrollments - Read
List enrollments
Depending on the URL given, return a paginated list of either (1) all of the enrollments in a course, (2) all of the enrollments in a section or (3) all of a user's enrollments. This includes student, teacher, TA, and observer enrollments. If a user has multiple enrollments in a context (e.g. as a teacher and a student or in multiple course sections), each enrollment will be listed separately. note: Currently, only a root level admin user can return other users' enrollments. A user can, however, return his/her own enrollments. Enrollments scoped to a course context will include inactive states by default if the caller has account admin authorization and the state[] parameter is omitted.
GET /v1/sections/{section_id}/enrollments - Read
List enrollments
Depending on the URL given, return a paginated list of either (1) all of the enrollments in a course, (2) all of the enrollments in a section or (3) all of a user's enrollments. This includes student, teacher, TA, and observer enrollments. If a user has multiple enrollments in a context (e.g. as a teacher and a student or in multiple course sections), each enrollment will be listed separately. note: Currently, only a root level admin user can return other users' enrollments. A user can, however, return his/her own enrollments. Enrollments scoped to a course context will include inactive states by default if the caller has account admin authorization and the state[] parameter is omitted.
GET /v1/users/{user_id}/enrollments - Read
Enrollment by ID
Get an Enrollment object by Enrollment ID
GET /v1/accounts/{account_id}/enrollments/{id} - Read
Show Temporary Enrollment recipient and provider status
Returns a JSON Object containing the temporary enrollment status for a user.
GET /v1/users/{user_id}/temporary_enrollment_status - Read
Bulk Temporary Enrollment Status
Returns temporary enrollment statuses for multiple users at once.
GET /v1/temporary_enrollment_status - Write
Enroll a user
Create a new user enrollment for a course or section.
POST /v1/courses/{course_id}/enrollments - Write
Enroll a user
Create a new user enrollment for a course or section.
POST /v1/sections/{section_id}/enrollments - Write
Enroll multiple users to one or more courses
Enrolls multiple users in one or more courses in a single operation.
POST /v1/accounts/{account_id}/bulk_enrollment - Write
Accept Course Invitation
accepts a pending course invitation for the current user
POST /v1/courses/{course_id}/enrollments/{id}/accept - Write
Reject Course Invitation
rejects a pending course invitation for the current user
POST /v1/courses/{course_id}/enrollments/{id}/reject - Destructive
Conclude, deactivate, or delete an enrollment
Conclude, deactivate, or delete an enrollment. If the +task+ argument isn't given, the enrollment will be concluded.
DELETE /v1/courses/{course_id}/enrollments/{id} - Destructive
Re-activate an enrollment
Activates an inactive enrollment
PUT /v1/courses/{course_id}/enrollments/{id}/reactivate - Destructive
Add last attended date
Add last attended date to student enrollment in course
PUT /v1/courses/{course_id}/users/{user_id}/last_attended
ePortfolios
- Read
Get all ePortfolios for a User
Get a list of all ePortfolios for the specified user.
GET /v1/users/{user_id}/eportfolios - Read
Get an ePortfolio
Get details for a single ePortfolio.
GET /v1/eportfolios/{id} - Read
Get ePortfolio Pages
Get details for the pages of an ePortfolio
GET /v1/eportfolios/{eportfolio_id}/pages - Destructive
Delete an ePortfolio
Mark an ePortfolio as deleted.
DELETE /v1/eportfolios/{id} - Destructive
Moderate an ePortfolio
Update the spamstatus of an eportfolio. Only available to admins who can moderateusercontent.
PUT /v1/eportfolios/{eportfolio_id}/moderate - Destructive
Moderate all ePortfolios for a User
Update the spamstatus for all active eportfolios of a user. Only available to admins who can moderateusercontent.
PUT /v1/users/{user_id}/eportfolios - Destructive
Restore a deleted ePortfolio
Restore an ePortfolio back to active that was previously deleted. Only available to admins who can moderateusercontent.
PUT /v1/eportfolios/{eportfolio_id}/restore
ePub Exports
- Read
List courses with their latest ePub export
A paginated list of all courses a user is actively participating in, and the latest ePub export associated with the user & course.
GET /v1/epub_exports - Read
Show ePub export
Get information about a single ePub export.
GET /v1/courses/{course_id}/epub_exports/{id} - Write
Create ePub Export
Begin an ePub export for a course. You can use the {api:ProgressControllershow Progress API} to track the progress of the export. The export's progress is linked to with the progressurl value. When the export completes, use the {api:EpubExportsControllershow Show content export} endpoint to retrieve a download URL for the exported content.
POST /v1/courses/{course_id}/epub_exports
Error Reports
- Write
Create Error Report
Create a new error report documenting an experienced problem Performs the same action as when a user uses the "help - report a problem" dialog.
POST /v1/error_reports
External Tools
- Read
List external tools
Returns the paginated list of external tools for the current context. See the get request docs for a single tool for a list of properties on an external tool.
GET /v1/courses/{course_id}/external_tools - Read
List external tools
Returns the paginated list of external tools for the current context. See the get request docs for a single tool for a list of properties on an external tool.
GET /v1/accounts/{account_id}/external_tools - Read
List external tools
Returns the paginated list of external tools for the current context. See the get request docs for a single tool for a list of properties on an external tool.
GET /v1/groups/{group_id}/external_tools - Read
Get a sessionless launch url for an external tool.
Returns a sessionless launch url for an external tool. Prefers the resourcelinklookupuuid, but defaults to the other passed parameters id, url, and launchtype NOTE: Either the resourcelinklookupuuid, id, or url must be provided unless launchtype is assessment or moduleitem.
GET /v1/courses/{course_id}/external_tools/sessionless_launch - Read
Get a sessionless launch url for an external tool.
Returns a sessionless launch url for an external tool. Prefers the resourcelinklookupuuid, but defaults to the other passed parameters id, url, and launchtype NOTE: Either the resourcelinklookupuuid, id, or url must be provided unless launchtype is assessment or moduleitem.
GET /v1/accounts/{account_id}/external_tools/sessionless_launch - Read
Get a single external tool
Returns the specified external tool.
GET /v1/courses/{course_id}/external_tools/{external_tool_id} - Read
Get a single external tool
Returns the specified external tool.
GET /v1/accounts/{account_id}/external_tools/{external_tool_id} - Write
Create an external tool
Create an external tool in the specified course/account. The created tool will be returned, see the "show" endpoint for an example. If a client ID is supplied canvas will attempt to create a context external tool using the LTI 1.3 standard. See the Placements Documentation for more information on what placements are available, the possible fields, and their accepted values.
POST /v1/courses/{course_id}/external_tools - Write
Create an external tool
Create an external tool in the specified course/account. The created tool will be returned, see the "show" endpoint for an example. If a client ID is supplied canvas will attempt to create a context external tool using the LTI 1.3 standard. See the Placements Documentation for more information on what placements are available, the possible fields, and their accepted values.
POST /v1/accounts/{account_id}/external_tools - Write
Mark tool as RCE Favorite
Mark the specified editorbutton external tool as a favorite in the RCE editor for courses in the given account and its subaccounts (if the subaccounts haven't set their own RCE Favorites). This places the tool in a preferred location in the RCE. Cannot mark more than 2 tools as RCE Favorites.
POST /v1/accounts/{account_id}/external_tools/rce_favorites/{id} - Destructive
Edit an external tool
Update the specified external tool. Uses same parameters as create. Returns the updated tool. NOTE: Any updates made to LTI 1.3 tools with this API will be overridden if any changes are made to the tool's associated LTI Registration/Developer Key configuration. In almost all cases, changes should be made to the tool's associated LTI Registration configuration, not individual tools.
PUT /v1/courses/{course_id}/external_tools/{external_tool_id} - Destructive
Edit an external tool
Update the specified external tool. Uses same parameters as create. Returns the updated tool. NOTE: Any updates made to LTI 1.3 tools with this API will be overridden if any changes are made to the tool's associated LTI Registration/Developer Key configuration. In almost all cases, changes should be made to the tool's associated LTI Registration configuration, not individual tools.
PUT /v1/accounts/{account_id}/external_tools/{external_tool_id} - Destructive
Delete an external tool
Remove the specified external tool
DELETE /v1/courses/{course_id}/external_tools/{external_tool_id} - Destructive
Delete an external tool
Remove the specified external tool
DELETE /v1/accounts/{account_id}/external_tools/{external_tool_id} - Destructive
Unmark tool as RCE Favorite
Unmark the specified external tool as a favorite in the RCE editor for the given account. The tool will remain available but will no longer appear in the preferred favorites location.
DELETE /v1/accounts/{account_id}/external_tools/rce_favorites/{id}
Favorites
- Read
List favorite courses
Retrieve the paginated list of favorite courses for the current user. If the user has not chosen any favorites, then a selection of currently enrolled courses will be returned. See the {api:CoursesControllerindex List courses API} for details on accepted include[] parameters.
GET /v1/users/self/favorites/courses - Read
List favorite groups
Retrieve the paginated list of favorite groups for the current user. If the user has not chosen any favorites, then a selection of groups that the user is a member of will be returned.
GET /v1/users/self/favorites/groups - Write
Add course to favorites
Add a course to the current user's favorites. If the course is already in the user's favorites, nothing happens. Canvas for Elementary subject and homeroom courses can be added to favorites, but this has no effect in the UI.
POST /v1/users/self/favorites/courses/{id} - Write
Add group to favorites
Add a group to the current user's favorites. If the group is already in the user's favorites, nothing happens.
POST /v1/users/self/favorites/groups/{id} - Destructive
Remove course from favorites
Remove a course from the current user's favorites.
DELETE /v1/users/self/favorites/courses/{id} - Destructive
Remove group from favorites
Remove a group from the current user's favorites.
DELETE /v1/users/self/favorites/groups/{id} - Destructive
Reset course favorites
Reset the current user's course favorites to the default automatically generated list of enrolled courses
DELETE /v1/users/self/favorites/courses - Destructive
Reset group favorites
Reset the current user's group favorites to the default automatically generated list of enrolled group
DELETE /v1/users/self/favorites/groups
Feature Flags
- Read
List features
A paginated list of all features that apply to a given Account, Course, or User.
GET /v1/courses/{course_id}/features - Read
List features
A paginated list of all features that apply to a given Account, Course, or User.
GET /v1/accounts/{account_id}/features - Read
List features
A paginated list of all features that apply to a given Account, Course, or User.
GET /v1/users/{user_id}/features - Read
List enabled features
A paginated list of all features that are enabled on a given Account, Course, or User. Only the feature names are returned.
GET /v1/courses/{course_id}/features/enabled - Read
List enabled features
A paginated list of all features that are enabled on a given Account, Course, or User. Only the feature names are returned.
GET /v1/accounts/{account_id}/features/enabled - Read
List enabled features
A paginated list of all features that are enabled on a given Account, Course, or User. Only the feature names are returned.
GET /v1/users/{user_id}/features/enabled - Read
List environment features
Return a hash of global feature options that pertain to the Canvas user interface. This is the same information supplied to the web interface as +ENV.FEATURES+.
GET /v1/features/environment - Read
Get feature flag
Get the feature flag that applies to a given Account, Course, or User. The flag may be defined on the object, or it may be inherited from a parent account. You can look at the contextid and contexttype of the returned object to determine which is the case. If these fields are missing, then the object is the global Canvas default.
GET /v1/courses/{course_id}/features/flags/{feature} - Read
Get feature flag
Get the feature flag that applies to a given Account, Course, or User. The flag may be defined on the object, or it may be inherited from a parent account. You can look at the contextid and contexttype of the returned object to determine which is the case. If these fields are missing, then the object is the global Canvas default.
GET /v1/accounts/{account_id}/features/flags/{feature} - Read
Get feature flag
Get the feature flag that applies to a given Account, Course, or User. The flag may be defined on the object, or it may be inherited from a parent account. You can look at the contextid and contexttype of the returned object to determine which is the case. If these fields are missing, then the object is the global Canvas default.
GET /v1/users/{user_id}/features/flags/{feature} - Destructive
Set feature flag
Set a feature flag for a given Account, Course, or User. This call will fail if a parent account sets a feature flag for the same feature in any state other than "allowed".
PUT /v1/courses/{course_id}/features/flags/{feature} - Destructive
Set feature flag
Set a feature flag for a given Account, Course, or User. This call will fail if a parent account sets a feature flag for the same feature in any state other than "allowed".
PUT /v1/accounts/{account_id}/features/flags/{feature} - Destructive
Set feature flag
Set a feature flag for a given Account, Course, or User. This call will fail if a parent account sets a feature flag for the same feature in any state other than "allowed".
PUT /v1/users/{user_id}/features/flags/{feature} - Destructive
Remove feature flag
Remove feature flag for a given Account, Course, or User. (Note that the flag must be defined on the Account, Course, or User directly.) The object will then inherit the feature flags from a higher account, if any exist. If this flag was 'on' or 'off', then lower-level account flags that were masked by this one will apply again.
DELETE /v1/courses/{course_id}/features/flags/{feature} - Destructive
Remove feature flag
Remove feature flag for a given Account, Course, or User. (Note that the flag must be defined on the Account, Course, or User directly.) The object will then inherit the feature flags from a higher account, if any exist. If this flag was 'on' or 'off', then lower-level account flags that were masked by this one will apply again.
DELETE /v1/accounts/{account_id}/features/flags/{feature} - Destructive
Remove feature flag
Remove feature flag for a given Account, Course, or User. (Note that the flag must be defined on the Account, Course, or User directly.) The object will then inherit the feature flags from a higher account, if any exist. If this flag was 'on' or 'off', then lower-level account flags that were masked by this one will apply again.
DELETE /v1/users/{user_id}/features/flags/{feature}
Files
- Read
Get quota information
Returns the total and used storage quota for the course, group, or user.
GET /v1/courses/{course_id}/files/quota - Read
Get quota information
Returns the total and used storage quota for the course, group, or user.
GET /v1/groups/{group_id}/files/quota - Read
Get quota information
Returns the total and used storage quota for the course, group, or user.
GET /v1/users/{user_id}/files/quota - Read
List files
Returns the paginated list of files for the folder or course.
GET /v1/courses/{course_id}/files - Read
List files
Returns the paginated list of files for the folder or course.
GET /v1/users/{user_id}/files - Read
List files
Returns the paginated list of files for the folder or course.
GET /v1/groups/{group_id}/files - Read
List files
Returns the paginated list of files for the folder or course.
GET /v1/folders/{id}/files - Read
Get public inline preview url
Determine the URL that should be used for inline preview of the file.
GET /v1/files/{id}/public_url - Read
Get file
Returns the standard attachment json object
GET /v1/files/{id} - Read
Get file
Returns the standard attachment json object
GET /v1/courses/{course_id}/files/{id} - Read
Get file
Returns the standard attachment json object
GET /v1/groups/{group_id}/files/{id} - Read
Get file
Returns the standard attachment json object
GET /v1/users/{user_id}/files/{id} - Read
Translate file reference
Get information about a file from a course copy file reference
GET /v1/courses/{course_id}/files/file_ref/{migration_id} - Read
Get icon metadata
Returns the icon maker file attachment metadata
GET /v1/files/{id}/icon_metadata - Read
List folders
Returns the paginated list of folders in the folder.
GET /v1/folders/{id}/folders - Read
List all folders
Returns the paginated list of all folders for the given context. This will be returned as a flat list containing all subfolders as well.
GET /v1/courses/{course_id}/folders - Read
List all folders
Returns the paginated list of all folders for the given context. This will be returned as a flat list containing all subfolders as well.
GET /v1/users/{user_id}/folders - Read
List all folders
Returns the paginated list of all folders for the given context. This will be returned as a flat list containing all subfolders as well.
GET /v1/groups/{group_id}/folders - Read
Resolve path
Given the full path to a folder, returns a list of all Folders in the path hierarchy, starting at the root folder, and ending at the requested folder. The given path is relative to the context's root folder and does not include the root folder's name (e.g., "course files"). If an empty path is given, the context's root folder alone is returned. Otherwise, if no folder exists with the given full path, a Not Found error is returned.
GET /v1/courses/{course_id}/folders/by_path/*full_path - Read
Resolve path
Given the full path to a folder, returns a list of all Folders in the path hierarchy, starting at the root folder, and ending at the requested folder. The given path is relative to the context's root folder and does not include the root folder's name (e.g., "course files"). If an empty path is given, the context's root folder alone is returned. Otherwise, if no folder exists with the given full path, a Not Found error is returned.
GET /v1/courses/{course_id}/folders/by_path - Read
Resolve path
Given the full path to a folder, returns a list of all Folders in the path hierarchy, starting at the root folder, and ending at the requested folder. The given path is relative to the context's root folder and does not include the root folder's name (e.g., "course files"). If an empty path is given, the context's root folder alone is returned. Otherwise, if no folder exists with the given full path, a Not Found error is returned.
GET /v1/users/{user_id}/folders/by_path/*full_path - Read
Resolve path
Given the full path to a folder, returns a list of all Folders in the path hierarchy, starting at the root folder, and ending at the requested folder. The given path is relative to the context's root folder and does not include the root folder's name (e.g., "course files"). If an empty path is given, the context's root folder alone is returned. Otherwise, if no folder exists with the given full path, a Not Found error is returned.
GET /v1/users/{user_id}/folders/by_path - Read
Resolve path
Given the full path to a folder, returns a list of all Folders in the path hierarchy, starting at the root folder, and ending at the requested folder. The given path is relative to the context's root folder and does not include the root folder's name (e.g., "course files"). If an empty path is given, the context's root folder alone is returned. Otherwise, if no folder exists with the given full path, a Not Found error is returned.
GET /v1/groups/{group_id}/folders/by_path/*full_path - Read
Resolve path
Given the full path to a folder, returns a list of all Folders in the path hierarchy, starting at the root folder, and ending at the requested folder. The given path is relative to the context's root folder and does not include the root folder's name (e.g., "course files"). If an empty path is given, the context's root folder alone is returned. Otherwise, if no folder exists with the given full path, a Not Found error is returned.
GET /v1/groups/{group_id}/folders/by_path - Read
Get folder
Returns the details for a folder You can get the root folder from a context by using 'root' as the :id. For example, you could get the root folder for a course like:
GET /v1/courses/{course_id}/folders/{id} - Read
Get folder
Returns the details for a folder You can get the root folder from a context by using 'root' as the :id. For example, you could get the root folder for a course like:
GET /v1/users/{user_id}/folders/{id} - Read
Get folder
Returns the details for a folder You can get the root folder from a context by using 'root' as the :id. For example, you could get the root folder for a course like:
GET /v1/groups/{group_id}/folders/{id} - Read
Get folder
Returns the details for a folder You can get the root folder from a context by using 'root' as the :id. For example, you could get the root folder for a course like:
GET /v1/folders/{id} - Read
Get uploaded media folder for user
Returns the details for a designated upload folder that the user has rights to upload to, and creates it if it doesn't exist. If the current user does not have the permissions to manage files in the course or group, the folder will belong to the current user directly.
GET /v1/courses/{course_id}/folders/media - Read
Get uploaded media folder for user
Returns the details for a designated upload folder that the user has rights to upload to, and creates it if it doesn't exist. If the current user does not have the permissions to manage files in the course or group, the folder will belong to the current user directly.
GET /v1/groups/{group_id}/folders/media - Read
List licenses
A paginated list of licenses that can be applied
GET /v1/courses/{course_id}/content_licenses - Read
List licenses
A paginated list of licenses that can be applied
GET /v1/groups/{group_id}/content_licenses - Read
List licenses
A paginated list of licenses that can be applied
GET /v1/users/{user_id}/content_licenses - Write
Update word count
Update the word count for a submission's attachment. This endpoint is designed to be called by external document viewers (like DocViewer) to report word counts back to Canvas.
POST /v1/files/update_word_count - Write
Create folder
Creates a folder in the specified context
POST /v1/courses/{course_id}/folders - Write
Create folder
Creates a folder in the specified context
POST /v1/users/{user_id}/folders - Write
Create folder
Creates a folder in the specified context
POST /v1/groups/{group_id}/folders - Write
Create folder
Creates a folder in the specified context
POST /v1/folders/{folder_id}/folders - Write
Create folder
Creates a folder in the specified context
POST /v1/accounts/{account_id}/folders - Write
Upload a file
Upload a file to a folder. This API endpoint is the first step in uploading a file. See the {file:file.fileuploads.html File Upload Documentation} for details on the file upload workflow. Only those with the "Manage Files" permission on a course or group can upload files to a folder in that course or group.
POST /v1/folders/{folder_id}/files - Write
Copy a file
Copy a file from elsewhere in Canvas into a folder. Copying a file across contexts (between courses and users) is permitted, but the source and destination must belong to the same institution.
POST /v1/folders/{dest_folder_id}/copy_file - Write
Copy a folder
Copy a folder (and its contents) from elsewhere in Canvas into a folder. Copying a folder across contexts (between courses and users) is permitted, but the source and destination must belong to the same institution. If the source and destination folders are in the same context, the source folder may not contain the destination folder. A folder will be renamed at its destination if another folder with the same name already exists.
POST /v1/folders/{dest_folder_id}/copy_folder - Destructive
Update file
Update some settings on the specified file
PUT /v1/files/{id} - Destructive
Delete file
Remove the specified file. Unlike most other DELETE endpoints, using this endpoint will result in comprehensive, irretrievable destruction of the file. It should be used with the replace parameter set to true in cases where the file preview also needs to be destroyed (such as to remove files that violate privacy laws).
DELETE /v1/files/{id} - Destructive
Reset link verifier (deprecated)
Resets the link verifier. Any existing links to the file using the previous hard-coded "verifier" parameter will no longer automatically grant access. Must have manage files and become other users permissions
POST /v1/files/{id}/reset_verifier - Destructive
Update folder
Updates a folder
PUT /v1/folders/{id} - Destructive
Delete folder
Remove the specified folder. You can only delete empty folders unless you set the 'force' flag
DELETE /v1/folders/{id} - Destructive
Set usage rights
Sets copyright and license information for one or more files
PUT /v1/courses/{course_id}/usage_rights - Destructive
Set usage rights
Sets copyright and license information for one or more files
PUT /v1/groups/{group_id}/usage_rights - Destructive
Set usage rights
Sets copyright and license information for one or more files
PUT /v1/users/{user_id}/usage_rights - Destructive
Remove usage rights
Removes copyright and license information associated with one or more files
DELETE /v1/courses/{course_id}/usage_rights - Destructive
Remove usage rights
Removes copyright and license information associated with one or more files
DELETE /v1/groups/{group_id}/usage_rights - Destructive
Remove usage rights
Removes copyright and license information associated with one or more files
DELETE /v1/users/{user_id}/usage_rights
Grade Change Log
- Read
Query by assignment
List grade change events for a given assignment.
GET /v1/audit/grade_change/assignments/{assignment_id} - Read
Query by course
List grade change events for a given course.
GET /v1/audit/grade_change/courses/{course_id} - Read
Query by student
List grade change events for a given student.
GET /v1/audit/grade_change/students/{student_id} - Read
Query by grader
List grade change events for a given grader.
GET /v1/audit/grade_change/graders/{grader_id} - Read
Advanced query
List grade change events satisfying all given parameters. Teachers may query for events in courses they teach. Queries without +courseid+ or +assignmentid+ require account administrator rights. At least one of +courseid+, +assignmentid+, +studentid+, or +graderid+ must be specified.
GET /v1/audit/grade_change
Gradebook History
- Read
Days in gradebook history for this course
Returns a map of dates to grader/assignment groups
GET /v1/courses/{course_id}/gradebook_history/days - Read
Details for a given date in gradebook history for this course
Returns the graders who worked on this day, along with the assignments they worked on. More details can be obtained by selecting a grader and assignment and calling the 'submissions' api endpoint for a given date.
GET /v1/courses/{course_id}/gradebook_history/{date} - Read
Lists submissions
Gives a nested list of submission versions
GET /v1/courses/{course_id}/gradebook_history/{date}/graders/{grader_id}/assignments/{assignment_id}/submissions - Read
List uncollated submission versions
Gives a paginated, uncollated list of submission versions for all matching submissions in the context. This SubmissionVersion objects will not include the +newgrade+ or +previousgrade+ keys, only the +grade+; same for +gradedat+ and +grader+.
GET /v1/courses/{course_id}/gradebook_history/feed
Grading Period Sets
- Read
List grading period sets
Returns the paginated list of grading period sets
GET /v1/accounts/{account_id}/grading_period_sets - Write
Create a grading period set
Create and return a new grading period set
POST /v1/accounts/{account_id}/grading_period_sets - Write
Update a grading period set
Update an existing grading period set 204 No Content response code is returned if the update was successful.
PATCH /v1/accounts/{account_id}/grading_period_sets/{id} - Destructive
Delete a grading period set
204 No Content response code is returned if the deletion was successful.
DELETE /v1/accounts/{account_id}/grading_period_sets/{id}
Grading Periods
- Read
List grading periods
Returns the paginated list of grading periods for the current course.
GET /v1/accounts/{account_id}/grading_periods - Read
List grading periods
Returns the paginated list of grading periods for the current course.
GET /v1/courses/{course_id}/grading_periods - Read
Get a single grading period
Returns the grading period with the given id
GET /v1/courses/{course_id}/grading_periods/{id} - Write
Batch update grading periods
Update multiple grading periods
PATCH /v1/courses/{course_id}/grading_periods/batch_update - Write
Batch update grading periods
Update multiple grading periods
PATCH /v1/grading_period_sets/{set_id}/grading_periods/batch_update - Destructive
Update a single grading period
Update an existing grading period.
PUT /v1/courses/{course_id}/grading_periods/{id} - Destructive
Delete a grading period
204 No Content response code is returned if the deletion was successful.
DELETE /v1/courses/{course_id}/grading_periods/{id} - Destructive
Delete a grading period
204 No Content response code is returned if the deletion was successful.
DELETE /v1/accounts/{account_id}/grading_periods/{id}
Grading Standards
- Read
List the grading standards available in a context.
Returns the paginated list of grading standards for the given context that are visible to the user.
GET /v1/courses/{course_id}/grading_standards - Read
List the grading standards available in a context.
Returns the paginated list of grading standards for the given context that are visible to the user.
GET /v1/accounts/{account_id}/grading_standards - Read
Get a single grading standard in a context.
Returns a grading standard for the given context that is visible to the user.
GET /v1/courses/{course_id}/grading_standards/{grading_standard_id} - Read
Get a single grading standard in a context.
Returns a grading standard for the given context that is visible to the user.
GET /v1/accounts/{account_id}/grading_standards/{grading_standard_id} - Write
Create a new grading standard
Create a new grading standard
POST /v1/accounts/{account_id}/grading_standards - Write
Create a new grading standard
Create a new grading standard
POST /v1/courses/{course_id}/grading_standards - Destructive
Update a grading standard
Updates the grading standard with the given id If the grading standard has been used for grading, only the title can be updated. The data, pointsbased, and scalingfactor cannot be modified once the grading standard has been used to grade assignments.
PUT /v1/courses/{course_id}/grading_standards/{grading_standard_id} - Destructive
Update a grading standard
Updates the grading standard with the given id If the grading standard has been used for grading, only the title can be updated. The data, pointsbased, and scalingfactor cannot be modified once the grading standard has been used to grade assignments.
PUT /v1/accounts/{account_id}/grading_standards/{grading_standard_id} - Destructive
Delete a grading standard
Deletes the grading standard with the given id
DELETE /v1/courses/{course_id}/grading_standards/{grading_standard_id} - Destructive
Delete a grading standard
Deletes the grading standard with the given id
DELETE /v1/accounts/{account_id}/grading_standards/{grading_standard_id}
Group Categories
- Read
List group categories for a context
Returns a paginated list of group categories in a context. The list returned depends on the permissions of the current user and the specified collaboration state.
GET /v1/accounts/{account_id}/group_categories - Read
List group categories for a context
Returns a paginated list of group categories in a context. The list returned depends on the permissions of the current user and the specified collaboration state.
GET /v1/courses/{course_id}/group_categories - Read
Get a single group category
Returns the data for a single group category, or a 401 if the caller doesn't have the rights to see it.
GET /v1/group_categories/{group_category_id} - Read
Get differentiation tag candidate count
Returns the number of students in the course eligible for a differentiation tag bulk-membership action (see Create a membership's allingroupcourse option), optionally narrowed by enrollment role and/or existing differentiation tag membership. The count only includes students visible to the calling user, so a section-limited teacher only sees students in their own sections.
GET /v1/courses/{course_id}/group_categories/differentiation_tag_candidate_count - Read
List groups in group category
Returns a paginated list of groups in a group category
GET /v1/group_categories/{group_category_id}/groups - Read
export groups in and users in category
Returns a csv file of users in format ready to import.
GET /v1/group_categories/{group_category_id}/export - Read
export tags and users in course
Returns a csv file of users in format ready to import.
GET /v1/courses/{course_id}/group_categories/export_tags - Read
List users in group category
Returns a paginated list of users in the group category.
GET /v1/group_categories/{group_category_id}/users - Write
Create a Group Category
Create a new group category
POST /v1/accounts/{account_id}/group_categories - Write
Create a Group Category
Create a new group category
POST /v1/courses/{course_id}/group_categories - Write
Bulk manage differentiation tags
This API is only meant for Groups and GroupCategories where noncollaborative is true. Perform bulk operations on groups within a group category, or create a new group category along with the groups in one transaction. If creation of the GroupCategory or any Group fails, the entire operation will be rolled back.
POST /v1/courses/{course_id}/group_categories/bulk_manage_differentiation_tag - Write
Import differentiation tags
Create Differentiation Tags through a CSV import For more information on the format that's expected here, please see the "Differentiation Tag CSV" section in the API docs.
POST /v1/courses/{course_id}/group_categories/import_tags - Write
Import category groups
Create Groups in a Group Category through a CSV import For more information on the format that's expected here, please see the "Group Category CSV" section in the API docs.
POST /v1/group_categories/{group_category_id}/import - Write
Assign unassigned members
Assign all unassigned members as evenly as possible among the existing student groups.
POST /v1/group_categories/{group_category_id}/assign_unassigned_members - Destructive
Update a Group Category
Modifies an existing group category.
PUT /v1/group_categories/{group_category_id} - Destructive
Delete a Group Category
Deletes a group category and all groups under it. Protected group categories can not be deleted, i.e. "communities" and "studentorganized".
DELETE /v1/group_categories/{group_category_id}
Groups
- Read
List your groups
Returns a paginated list of active groups for the current user.
GET /v1/users/self/groups - Read
List the groups available in a context.
Returns the paginated list of active groups in the given context that are visible to user.
GET /v1/accounts/{account_id}/groups - Read
List the groups available in a context.
Returns the paginated list of active groups in the given context that are visible to user.
GET /v1/courses/{course_id}/groups - Read
Bulk fetch user tags for multiple users in a course
Returns a mapping of user IDs to arrays of non-collaborative group (tag) IDs for each user in the given course.
GET /v1/courses/{course_id}/bulk_user_tags - Read
Get a single group
Returns the data for a single group, or a 401 if the caller doesn't have the rights to see it.
GET /v1/groups/{group_id} - Read
List group's users
Returns a paginated list of users in the group.
GET /v1/groups/{group_id}/users - Read
Preview processed html
Preview html content processed for this group
POST /v1/groups/{group_id}/preview_html - Read
Group activity stream
Returns the current user's group-specific activity stream, paginated. For full documentation, see the API documentation for the user activity stream, in the user api.
GET /v1/groups/{group_id}/activity_stream - Read
Group activity stream summary
Returns a summary of the current user's group-specific activity stream. For full documentation, see the API documentation for the user activity stream summary, in the user api.
GET /v1/groups/{group_id}/activity_stream/summary - Read
Permissions
Returns permission information for the calling user in the given group. See also the {api:AccountsControllerpermissions Account} and {api:CoursesControllerpermissions Course} counterparts.
GET /v1/groups/{group_id}/permissions - Read
List group memberships
A paginated list of the members of a group.
GET /v1/groups/{group_id}/memberships - Read
Get a single group membership
Returns the group membership with the given membership id or user id.
GET /v1/groups/{group_id}/memberships/{membership_id} - Read
Get a single group membership
Returns the group membership with the given membership id or user id.
GET /v1/groups/{group_id}/users/{user_id} - Write
Create a group
Creates a new group. Groups created using the "/api/v1/groups/" endpoint will be community groups.
POST /v1/groups - Write
Create a group
Creates a new group. Groups created using the "/api/v1/groups/" endpoint will be community groups.
POST /v1/group_categories/{group_category_id}/groups - Write
Invite others to a group
Sends an invitation to all supplied email addresses which will allow the receivers to join the group.
POST /v1/groups/{group_id}/invite - Write
Upload a file
Upload a file to the group. This API endpoint is the first step in uploading a file to a group. See the {file:file.fileuploads.html File Upload Documentation} for details on the file upload workflow. Only those with the "Manage Files" permission on a group can upload files to the group. By default, this is anybody participating in the group, or any admin over the group.
POST /v1/groups/{group_id}/files - Write
Create a membership
Join, or request to join, a group, depending on the joinlevel of the group. If the membership or join request already exists, then it is simply returned. For differentiation tags, you can bulk add users using one of two methods: 1. Provide an array of user IDs via the members[] parameter. 2. Use the course-wide option with the following parameters: - allingroupcourse [Boolean]: If set to true, the endpoint will add every currently enrolled student (from the course context) to the differentiation tag. - excludeuserids[] [Integer]: When using allingroupcourse, you can optionally exclude specific users by providing their IDs in this parameter. - enrollmentroleid[] [Integer]: When using allingroupcourse, restrict the bulk add to students holding one of these enrollment roles. - differentiationtagid[] [Integer]: When using allingroupcourse, restrict the bulk add to students who are members of one of these differentiation tags. In this context, these parameters only apply to differentiation tag memberships.
POST /v1/groups/{group_id}/memberships - Destructive
Edit a group
Modifies an existing group. Note that to set an avatar image for the group, you must first upload the image file to the group, and the use the id in the response as the argument to this function. See the {file:file.fileuploads.html File Upload Documentation} for details on the file upload workflow.
PUT /v1/groups/{group_id} - Destructive
Delete a group
Deletes a group and removes all members.
DELETE /v1/groups/{group_id} - Destructive
Update a membership
Accept a membership request, or add/remove moderator rights.
PUT /v1/groups/{group_id}/memberships/{membership_id} - Destructive
Update a membership
Accept a membership request, or add/remove moderator rights.
PUT /v1/groups/{group_id}/users/{user_id} - Destructive
Leave a group
Leave a group if you are allowed to leave (some groups, such as sets of course groups created by teachers, cannot be left). You may also use 'self' in place of a membershipid.
DELETE /v1/groups/{group_id}/memberships/{membership_id} - Destructive
Leave a group
Leave a group if you are allowed to leave (some groups, such as sets of course groups created by teachers, cannot be left). You may also use 'self' in place of a membershipid.
DELETE /v1/groups/{group_id}/users/{user_id} - Destructive
Bulk delete memberships Bulk deletes memberships by providing an array of user IDs, or, for differentiation tag groups,…
Bulk delete memberships Bulk deletes memberships by providing an array of user IDs, or, for differentiation tag groups,…
DELETE /v1/groups/{group_id}/users
History
- Read
List recent history for a user
Return a paginated list of the user's recent history. History entries are returned in descending order, newest to oldest. You may list history entries for yourself (use +self+ as the userid), for a student you observe, or for a user you manage as an administrator. Note that the +perpage+ pagination argument is not supported and the number of history entries returned per page will vary.
GET /v1/users/{user_id}/history
InstAccess tokens
- Write
[DEPRECATED] Create InstAccess token
Create a unique, encrypted InstAccess token. Generates a different InstAccess token each time it's called, each one expires after a short window (1 hour).
POST /v1/inst_access_tokens
JWTs
- Write
Create JWT
Create a unique JWT for use with other Canvas services Generates a different JWT each time it's called. Each JWT expires after a short window (1 hour)
POST /v1/jwts - Write
Refresh JWT
Refresh a JWT for use with other canvas services Generates a different JWT each time it's called, each one expires after a short window (1 hour).
POST /v1/jwts/refresh
Late Policy
- Read
Get a late policy
Returns the late policy for a course.
GET /v1/courses/{id}/late_policy - Write
Create a late policy
Create a late policy. If the course already has a late policy, a badrequest is returned since there can only be one late policy per course.
POST /v1/courses/{id}/late_policy - Write
Patch a late policy
Patch a late policy. No body is returned upon success.
PATCH /v1/courses/{id}/late_policy
Learning Object Dates
- Read
Get a learning object's date information
Get a learning object's date-related information, including due date, availability dates, override status, and a paginated list of all assignment overrides for the item.
GET /v1/courses/{course_id}/modules/{context_module_id}/date_details - Read
Get a learning object's date information
Get a learning object's date-related information, including due date, availability dates, override status, and a paginated list of all assignment overrides for the item.
GET /v1/courses/{course_id}/assignments/{assignment_id}/date_details - Read
Get a learning object's date information
Get a learning object's date-related information, including due date, availability dates, override status, and a paginated list of all assignment overrides for the item.
GET /v1/courses/{course_id}/quizzes/{quiz_id}/date_details - Read
Get a learning object's date information
Get a learning object's date-related information, including due date, availability dates, override status, and a paginated list of all assignment overrides for the item.
GET /v1/courses/{course_id}/discussion_topics/{discussion_topic_id}/date_details - Read
Get a learning object's date information
Get a learning object's date-related information, including due date, availability dates, override status, and a paginated list of all assignment overrides for the item.
GET /v1/courses/{course_id}/pages/{url_or_id}/date_details - Read
Get a learning object's date information
Get a learning object's date-related information, including due date, availability dates, override status, and a paginated list of all assignment overrides for the item.
GET /v1/courses/{course_id}/files/{attachment_id}/date_details - Destructive
Update a learning object's date information
Updates date-related information for learning objects, including due date, availability dates, override status, and assignment overrides. Returns 204 No Content response code if successful.
PUT /v1/courses/{course_id}/assignments/{assignment_id}/date_details - Destructive
Update a learning object's date information
Updates date-related information for learning objects, including due date, availability dates, override status, and assignment overrides. Returns 204 No Content response code if successful.
PUT /v1/courses/{course_id}/quizzes/{quiz_id}/date_details - Destructive
Update a learning object's date information
Updates date-related information for learning objects, including due date, availability dates, override status, and assignment overrides. Returns 204 No Content response code if successful.
PUT /v1/courses/{course_id}/discussion_topics/{discussion_topic_id}/date_details - Destructive
Update a learning object's date information
Updates date-related information for learning objects, including due date, availability dates, override status, and assignment overrides. Returns 204 No Content response code if successful.
PUT /v1/courses/{course_id}/pages/{url_or_id}/date_details - Destructive
Update a learning object's date information
Updates date-related information for learning objects, including due date, availability dates, override status, and assignment overrides. Returns 204 No Content response code if successful.
PUT /v1/courses/{course_id}/files/{attachment_id}/date_details
Line Items
- Read
Show a Line Item
Show existing Line Item
GET /lti/courses/{course_id}/line_items/{id} - Read
List line Items
List all Line Items for a course
GET /lti/courses/{course_id}/line_items - Write
Create a Line Item
Create a new Line Item
POST /lti/courses/{course_id}/line_items - Destructive
Update a Line Item
Update new Line Item
PUT /lti/courses/{course_id}/line_items/{id} - Destructive
Delete a Line Item
Delete an existing Line Item
DELETE /lti/courses/{course_id}/line_items/{id}
LiveAssessments
- Read
List live assessment results
Returns a paginated list of live assessment results
GET /v1/courses/{course_id}/live_assessments/{assessment_id}/results - Read
List live assessments
Returns a paginated list of live assessments.
GET /v1/courses/{course_id}/live_assessments - Write
Create live assessment results
Creates live assessment results and adds them to a live assessment
POST /v1/courses/{course_id}/live_assessments/{assessment_id}/results - Write
Create or find a live assessment
Creates or finds an existing live assessment with the given key and aligns it with the linked outcome
POST /v1/courses/{course_id}/live_assessments
Logins
- Read
List user logins
Given a user ID, return a paginated list of that user's logins for the given account.
GET /v1/accounts/{account_id}/logins - Read
List user logins
Given a user ID, return a paginated list of that user's logins for the given account.
GET /v1/users/{user_id}/logins - Write
Kickoff password recovery flow
Given a user email, generate a nonce and email it to the user
POST /v1/users/reset_password - Write
Create a user login
Create a new login for an existing user in the given account.
POST /v1/accounts/{account_id}/logins - Destructive
Edit a user login
Update an existing login for a user in the given account.
PUT /v1/accounts/{account_id}/logins/{id} - Destructive
Delete a user login
Delete an existing login.
DELETE /v1/users/{user_id}/logins/{id}
LTI ContextControls
- Read
List All Context Controls
List all LTI ContextControls for the given LTI Registration. These controls are partitioned by LTI Deployment, and have added calculated fields for display in the Canvas UI. This endpoint is used to populate the Availability page for an LTI Registration and may not be useful for general API Usage. For listing all ContextControls for a given Deployment, see the LTI Deployments - List Controls for Deployment endpoint.
GET /v1/accounts/{account_id}/lti_registrations/{registration_id}/controls - Read
Show LTI Context Control
Display details of the specified LTI ContextControl for the specified LTI registration in this context.
GET /v1/accounts/{account_id}/lti_registrations/{registration_id}/controls/{id} - Write
Create LTI Context Control
Create a new LTI ContextControl for the specified LTI registration in this context.
POST /v1/accounts/{current_account_id}/lti_registrations/{registration_id}/controls - Write
Bulk Create LTI Context Controls
Create up to 100 new LTI ContextControls for the specified LTI registration in this context. Control parameters are sent as a JSON array of objects, each with the same parameters as the Create LTI Context Control endpoint. Note that if a control already exists for the specified context and deployment, it will be updated instead of created.
POST /v1/accounts/{account_id}/lti_registrations/{registration_id}/controls/bulk - Destructive
Modify a Context Control
Changes the availability of a context control. This endpoint can only be used to change the availability of a context control; no other attributes about the control (such as which course or account it belongs to) can be changed here. To change those values, the control should be deleted and a new one created instead. Returns the context control with its new availability value applied.
PUT /v1/accounts/{account_id}/lti_registrations/{registration_id}/controls/{id} - Destructive
Delete a Context Control
Deletes a context control. Returns the control that is now deleted. Note: Deleting the "primary" control for a deployment (the control associated with the context where the deployment is installed) is not allowed and will return an error. This prevents situations where a deployment cannot be managed from the Apps page.
DELETE /v1/accounts/{account_id}/lti_registrations/{registration_id}/controls/{id}
LTI Launch Definitions
- Read
List LTI Launch Definitions
List all tools available in this context for the given placements, in the form of Launch Definitions. Used primarily by the Canvas frontend. API users should consider using the External Tools API instead. This endpoint is cached for 10 minutes!
GET /v1/courses/{course_id}/lti_apps/launch_definitions - Read
List LTI Launch Definitions
List all tools available in this context for the given placements, in the form of Launch Definitions. Used primarily by the Canvas frontend. API users should consider using the External Tools API instead. This endpoint is cached for 10 minutes!
GET /v1/accounts/{account_id}/lti_apps/launch_definitions
LTI Registrations
- Read
List LTI Registrations in an account
Returns all LTI registrations in the specified account. Includes registrations created in this account, those set to 'allow' from a parent root account (like Site Admin) and 'on' for this account, and those enabled 'on' at the parent root account level.
GET /v1/accounts/{account_id}/lti_registrations - Read
List LTI Registrations in an account
Returns all LTI registrations in the specified account. Includes registrations created in this account, those set to 'allow' from a parent root account (like Site Admin) and 'on' for this account, and those enabled 'on' at the parent root account level.
GET /v1/accounts/{account_id}/apps - Read
Show an LTI Registration
Return details about the specified LTI registration, including the configuration and account binding.
GET /v1/accounts/{account_id}/lti_registrations/{id} - Read
Show an LTI Registration
Return details about the specified LTI registration, including the configuration and account binding.
GET /v1/accounts/{account_id}/apps/{id} - Read
Show an LTI Registration (via the clientid)
Returns details about the specified LTI registration, including the configuration and account binding.
GET /v1/accounts/{account_id}/lti_registration_by_client_id/{client_id} - Read
Show an LTI Registration (via the clientid)
Returns details about the specified LTI registration, including the configuration and account binding.
GET /v1/accounts/{account_id}/app_by_client_id/{client_id} - Read
Get LTI Registration by Unified Tool ID
Returns an LTI registration by looking up its unifiedtoolid. Searches both manual configurations and IMS registrations. Only returns registrations that are active and accessible from the current account (owned by account, Site Admin, or has binding).
GET /v1/accounts/{account_id}/lti_registrations/by_utid/{utid} - Read
Get LTI Registration by Unified Tool ID
Returns an LTI registration by looking up its unifiedtoolid. Searches both manual configurations and IMS registrations. Only returns registrations that are active and accessible from the current account (owned by account, Site Admin, or has binding).
GET /v1/accounts/{account_id}/apps/by_utid/{utid} - Read
Check LTI Registration Install Status
Returns the local installation status for a Site Admin LTI registration. If the developer key's registration is in Site Admin, returns the local copy in the current account (if installed). If the registration is already in the current account, returns it directly.
GET /v1/accounts/{account_id}/lti_registrations/install_status/{client_id} - Read
Check LTI Registration Install Status
Returns the local installation status for a Site Admin LTI registration. If the developer key's registration is in Site Admin, returns the local copy in the current account (if installed). If the registration is already in the current account, returns it directly.
GET /v1/accounts/{account_id}/apps/install_status/{client_id} - Read
Search for Accounts and Courses
This is a utility endpoint used by the Canvas Apps UI and may not serve general use cases. Search for accounts and courses that match the search term on name, SIS id, or course code. Returns all matching accounts and courses, including those nested in sub-accounts. Returns bare-bones data about each account and course, and only up to 20 of each. Used to populate the search dropdowns when managing LTI registration availability.
GET /v1/accounts/{account_id}/lti_registrations/{registration_id}/deployments/{deployment_id}/context_search - Read
Search for Accounts and Courses
This is a utility endpoint used by the Canvas Apps UI and may not serve general use cases. Search for accounts and courses that match the search term on name, SIS id, or course code. Returns all matching accounts and courses, including those nested in sub-accounts. Returns bare-bones data about each account and course, and only up to 20 of each. Used to populate the search dropdowns when managing LTI registration availability.
GET /v1/accounts/{account_id}/apps/{registration_id}/deployments/{deployment_id}/context_search - Read
Get LTI Registration Overlay History
Returns the overlay history items for the specified LTI registration.
GET /v1/accounts/{account_id}/lti_registrations/{id}/overlay_history - Read
Get LTI Registration Overlay History
Returns the overlay history items for the specified LTI registration.
GET /v1/accounts/{account_id}/apps/{id}/overlay_history - Read
Get LTI Registration History
Returns the history entries for the specified LTI registration. This endpoint provides comprehensive change tracking for all fields associated with the registration, including registration fields, developer key changes, internal configuration changes, and overlay changes. Supports pagination using the page and perpage parameters. The default page size is 10.
GET /v1/accounts/{account_id}/lti_registrations/{id}/history - Read
Get LTI Registration History
Returns the history entries for the specified LTI registration. This endpoint provides comprehensive change tracking for all fields associated with the registration, including registration fields, developer key changes, internal configuration changes, and overlay changes. Supports pagination using the page and perpage parameters. The default page size is 10.
GET /v1/accounts/{account_id}/apps/{id}/history - Read
Get LTI Registration Update Request
Retrieves details about a specific registration update request.
GET /v1/accounts/{account_id}/lti_registrations/{id}/update_requests/{update_request_id} - Read
Get LTI Registration Update Request
Retrieves details about a specific registration update request.
GET /v1/accounts/{account_id}/apps/{id}/update_requests/{update_request_id} - Read
Get Latest LTI Registration Update Request
Retrieves the most recent update request for a registration, regardless of its status. Returns 404 if there are no update requests for this registration.
GET /v1/accounts/{account_id}/lti_registrations/{id}/latest_update_request - Read
Get Latest LTI Registration Update Request
Retrieves the most recent update request for a registration, regardless of its status. Returns 404 if there are no update requests for this registration.
GET /v1/accounts/{account_id}/apps/{id}/latest_update_request - Write
Create an LTI Registration
Create a new LTI Registration, as well as an associated Tool Configuration, Developer Key, and Registration Account binding. To install/create using Dynamic Registration, please use the {file:file.registration.html Dynamic Registration API}.
POST /v1/accounts/{account_id}/lti_registrations - Write
Create an LTI Registration
Create a new LTI Registration, as well as an associated Tool Configuration, Developer Key, and Registration Account binding. To install/create using Dynamic Registration, please use the {file:file.registration.html Dynamic Registration API}.
POST /v1/accounts/{account_id}/apps - Write
Bind an LTI Registration to a Root Account
Enable or disable the specified LTI registration for the specified root account. To enable an inherited registration (eg from Site Admin), pass the registration's global ID. Only allowed for root accounts. Specifics for centrally-managed/federated consortia: Child root accounts may not bind inherited registrations. For parent root account, binding also applies to all child root accounts.
POST /v1/accounts/{account_id}/lti_registrations/{id}/bind - Write
Bind an LTI Registration to a Root Account
Enable or disable the specified LTI registration for the specified root account. To enable an inherited registration (eg from Site Admin), pass the registration's global ID. Only allowed for root accounts. Specifics for centrally-managed/federated consortia: Child root accounts may not bind inherited registrations. For parent root account, binding also applies to all child root accounts.
POST /v1/accounts/{account_id}/apps/{id}/bind - Write
Install an LTI Registration from a Template
This endpoint installs a local copy of a "template" LTI registration from Site Admin into the specified account. The local copy can then be customized for the account without affecting the template registration. Only allowed for root accounts and for registrations from Site Admin marked as templates.
POST /v1/accounts/{account_id}/lti_registrations/{id}/install_from_template - Write
Install an LTI Registration from a Template
This endpoint installs a local copy of a "template" LTI registration from Site Admin into the specified account. The local copy can then be customized for the account without affecting the template registration. Only allowed for root accounts and for registrations from Site Admin marked as templates.
POST /v1/accounts/{account_id}/apps/{id}/install_from_template - Destructive
Update an LTI Registration
Update the specified LTI registration with the provided parameters. Note that updating the base tool configuration of a registration that is associated with a Dynamic Registration will return a 422. All other fields can be updated freely.
PUT /v1/accounts/{account_id}/lti_registrations/{id} - Destructive
Update an LTI Registration
Update the specified LTI registration with the provided parameters. Note that updating the base tool configuration of a registration that is associated with a Dynamic Registration will return a 422. All other fields can be updated freely.
PUT /v1/accounts/{account_id}/apps/{id} - Destructive
Reset an LTI Registration to Defaults
Reset the specified LTI registration to its default settings in this context. This removes all customizations that were present in the overlay associated with this context.
PUT /v1/accounts/{account_id}/lti_registrations/{id}/reset - Destructive
Reset an LTI Registration to Defaults
Reset the specified LTI registration to its default settings in this context. This removes all customizations that were present in the overlay associated with this context.
PUT /v1/accounts/{account_id}/apps/{id}/reset - Destructive
Delete an LTI Registration
Remove the specified LTI registration
DELETE /v1/accounts/{account_id}/lti_registrations/{id} - Destructive
Delete an LTI Registration
Remove the specified LTI registration
DELETE /v1/accounts/{account_id}/apps/{id} - Destructive
Remove an Inherited LTI Registration
Deletes the account binding for this registration, effectively removing it from the account. Only available when the ltideactivateregistrations feature flag is enabled. Only valid for inherited (Site Admin) registrations — use destroy for registrations owned by this account.
DELETE /v1/accounts/{account_id}/lti_registrations/{id}/bind - Destructive
Remove an Inherited LTI Registration
Deletes the account binding for this registration, effectively removing it from the account. Only available when the ltideactivateregistrations feature flag is enabled. Only valid for inherited (Site Admin) registrations — use destroy for registrations owned by this account.
DELETE /v1/accounts/{account_id}/apps/{id}/bind - Destructive
Apply LTI Registration Update Requst
Applies a registration update request to an existing registration, replacing the existing configuration and overlay with the new values. If the request is rejected, marks it as rejected without applying changes.
PUT /v1/accounts/{account_id}/lti_registrations/{id}/update_requests/{update_request_id}/apply - Destructive
Apply LTI Registration Update Requst
Applies a registration update request to an existing registration, replacing the existing configuration and overlay with the new values. If the request is rejected, marks it as rejected without applying changes.
PUT /v1/accounts/{account_id}/apps/{id}/update_requests/{update_request_id}/apply
LTI Resource Links
- Read
List LTI Resource Links
Returns all Resource Links in the specified course. This includes links that are associated with Assignments, Module Items, Collaborations, and that are embedded in rich content. This endpoint is paginated, and will return 50 links per page by default. Links are sorted by the order in which they were created.
GET /v1/courses/{course_id}/lti_resource_links - Read
Show an LTI Resource Link
Return details about the specified resource link. The ID can be in the standard Canvas format ("1"), or in these special formats: - resourcelinkuuid: - Find the resource link by its resourcelinkuuid - lookupuuid: - Find the resource link by its lookupuuid
GET /v1/courses/{course_id}/lti_resource_links/{id} - Write
Create an LTI Resource Link
Create a new LTI Resource Link in the specified course with the provided parameters. Caution! Resource Links are usually created by the tool via LTI Deep Linking. The tool has no knowledge of links created via this API, and may not be able to handle or launch them. Links created using this API cannot be associated with a specific piece of Canvas content, like an Assignment, Module Item, or Collaboration. Links created using this API are only suitable for embedding in rich content using the canvaslaunchurl provided in the API response. This link will be associated with the ContextExternalTool available in this context that matches the provided url. If a matching tool is not found, the link will not be created and this will return an error.
POST /v1/courses/{course_id}/lti_resource_links - Write
Bulk Create LTI Resource Links
Create up to 100 new LTI Resource Links in the specified course with the provided parameters. Caution! Resource Links are usually created by the tool via LTI Deep Linking. The tool has no knowledge of links created via this API, and may not be able to handle or launch them. Links created using this API cannot be associated with a specific piece of Canvas content, like an Assignment, Module Item, or Collaboration. Links created using this API are only suitable for embedding in rich content using the canvaslaunchurl provided in the API response. Each link will be associated with the ContextExternalTool available in this context that matches the provided url. If a matching tool is not found, or any parameters are invalid, no links will be created and this will return an error.
POST /v1/courses/{course_id}/lti_resource_links/bulk - Destructive
Update an LTI Resource Link
Update the specified resource link with the provided parameters. Caution! Changing existing links may result in launch errors.
PUT /v1/courses/{course_id}/lti_resource_links/{id} - Destructive
Delete an LTI Resource Link
Delete the specified resource link. The ID can be in the standard Canvas format ("1"), or in these special formats: - resourcelinkuuid: - Find the resource link by its resourcelinkuuid - lookupuuid: - Find the resource link by its lookupuuid Only links that are not associated with Assignments, Module Items, or Collaborations can be deleted.
DELETE /v1/courses/{course_id}/lti_resource_links/{id}
Media Objects
- Read
List media tracks for a Media Object or Attachment
List the media tracks associated with a media object or attachment
GET /v1/media_objects/{media_object_id}/media_tracks - Read
List media tracks for a Media Object or Attachment
List the media tracks associated with a media object or attachment
GET /v1/media_attachments/{attachment_id}/media_tracks - Read
List Media Objects
Returns media objects created by the user making the request. When using the second version, returns media objects associated with the given course.
GET /v1/media_objects - Read
List Media Objects
Returns media objects created by the user making the request. When using the second version, returns media objects associated with the given course.
GET /v1/courses/{course_id}/media_objects - Read
List Media Objects
Returns media objects created by the user making the request. When using the second version, returns media objects associated with the given course.
GET /v1/groups/{group_id}/media_objects - Read
List Media Objects
Returns media objects created by the user making the request. When using the second version, returns media objects associated with the given course.
GET /v1/media_attachments - Read
List Media Objects
Returns media objects created by the user making the request. When using the second version, returns media objects associated with the given course.
GET /v1/courses/{course_id}/media_attachments - Read
List Media Objects
Returns media objects created by the user making the request. When using the second version, returns media objects associated with the given course.
GET /v1/groups/{group_id}/media_attachments - Destructive
Update Media Tracks
Replace the media tracks associated with a media object or attachment with the array of tracks provided in the body. Update will delete any existing tracks not listed, leave untouched any tracks with no content field, and update or create tracks with a content field.
PUT /v1/media_objects/{media_object_id}/media_tracks - Destructive
Update Media Tracks
Replace the media tracks associated with a media object or attachment with the array of tracks provided in the body. Update will delete any existing tracks not listed, leave untouched any tracks with no content field, and update or create tracks with a content field.
PUT /v1/media_attachments/{attachment_id}/media_tracks - Destructive
Update Media Object
Updates the title of a media object.
PUT /v1/media_objects/{media_object_id} - Destructive
Update Media Object
Updates the title of a media object.
PUT /v1/media_attachments/{attachment_id}
Moderated Grading
- Read
List students selected for moderation
Returns a paginated list of students selected for moderation
GET /v1/courses/{course_id}/assignments/{assignment_id}/moderated_students - Read
Show provisional grade status for a student
Tell whether the student's submission needs one or more provisional grades.
GET /v1/courses/{course_id}/assignments/{assignment_id}/provisional_grades/status - Read
Show provisional grade status for a student
Determine whether or not the student's submission needs one or more provisional grades.
GET /v1/courses/{course_id}/assignments/{assignment_id}/anonymous_provisional_grades/status - Write
Select students for moderation
Returns an array of users that were selected for moderation
POST /v1/courses/{course_id}/assignments/{assignment_id}/moderated_students - Write
Publish provisional grades for an assignment (deprecated)
Publish the selected provisional grade for all submissions to an assignment. Use the "Select provisional grade" endpoint to choose which provisional grade to publish for a particular submission. Students not in the moderation set will have their one and only provisional grade published. WARNING: This is irreversible. This will overwrite existing grades in the gradebook.
POST /v1/courses/{course_id}/assignments/{assignment_id}/provisional_grades/publish - Write
Publish provisional grades for an assignment (asynchronous)
Publish the selected provisional grade for all submissions to an assignment in a background job. Unlike the synchronous "Publish provisional grades" endpoint, this returns immediately with a Progress object that can be polled for completion. Use the "Select provisional grade" endpoint to choose which provisional grade to publish for a particular submission. Students not in the moderation set will have their one and only provisional grade published. WARNING: This is irreversible. This will overwrite existing grades in the gradebook.
POST /v1/courses/{course_id}/assignments/{assignment_id}/provisional_grades/publish_async - Destructive
Bulk select provisional grades
Choose which provisional grades will be received by associated students for an assignment. The caller must be the final grader for the assignment or an admin with :selectfinalgrade rights.
PUT /v1/courses/{course_id}/assignments/{assignment_id}/provisional_grades/bulk_select - Destructive
Select provisional grade
Choose which provisional grade the student should receive for a submission. The caller must be the final grader for the assignment or an admin with :selectfinalgrade rights.
PUT /v1/courses/{course_id}/assignments/{assignment_id}/provisional_grades/{provisional_grade_id}/select
Module Organization
- Write
Propose a module organization
Propose a module organization
POST /v1/courses/{course_id}/module_organization - Write
Apply a module organization
Apply a module organization
POST /v1/courses/{course_id}/module_organization/apply
Modules
- Read
List modules
A paginated list of the modules in a course
GET /v1/courses/{course_id}/modules - Read
Show module
Get information about a single module
GET /v1/courses/{course_id}/modules/{id} - Read
List module items
A paginated list of the items in a module
GET /v1/courses/{course_id}/modules/{module_id}/items - Read
Show module item
Get information about a single module item
GET /v1/courses/{course_id}/modules/{module_id}/items/{id} - Read
Get module item sequence
Given an asset in a course, find the ModuleItem it belongs to, the previous and next Module Items in the course sequence, and also any applicable mastery path rules
GET /v1/courses/{course_id}/module_item_sequence - Read
List a module's overrides
Returns a paginated list of AssignmentOverrides that apply to the ContextModule.
GET /v1/courses/{course_id}/modules/{context_module_id}/assignment_overrides - Write
Create a module
Create and return a new module
POST /v1/courses/{course_id}/modules - Write
Create a module item
Create and return a new module item
POST /v1/courses/{course_id}/modules/{module_id}/items - Write
Select a mastery path
Select a mastery path when module item includes several possible paths. Requires Mastery Paths feature to be enabled. Returns a compound document with the assignments included in the given path and any module items related to those assignments
POST /v1/courses/{course_id}/modules/{module_id}/items/{id}/select_mastery_path - Write
Mark module item read
Fulfills "must view" requirement for a module item. It is generally not necessary to do this explicitly, but it is provided for applications that need to access external content directly (bypassing the htmlurl redirect that normally allows Canvas to fulfill "must view" requirements). This endpoint cannot be used to complete requirements on locked or unpublished module items.
POST /v1/courses/{course_id}/modules/{module_id}/items/{id}/mark_read - Destructive
Update a module
Update and return an existing module
PUT /v1/courses/{course_id}/modules/{id} - Destructive
Delete module
Delete a module
DELETE /v1/courses/{course_id}/modules/{id} - Destructive
Re-lock module progressions
Resets module progressions to their default locked state and recalculates them based on the current requirements. Adding progression requirements to an active course will not lock students out of modules they have already unlocked unless this action is called.
PUT /v1/courses/{course_id}/modules/{id}/relock - Destructive
Update a module item
Update and return an existing module item
PUT /v1/courses/{course_id}/modules/{module_id}/items/{id} - Destructive
Delete module item
Delete a module item
DELETE /v1/courses/{course_id}/modules/{module_id}/items/{id} - Destructive
Mark module item as done/not done
Mark a module item as done/not done. Use HTTP method PUT to mark as done, and DELETE to mark as not done.
PUT /v1/courses/{course_id}/modules/{module_id}/items/{id}/done - Destructive
Update a module's overrides
Accepts a list of overrides and applies them to the ContextModule. Returns 204 No Content response code if successful.
PUT /v1/courses/{course_id}/modules/{context_module_id}/assignment_overrides
Names and Role
- Read
List Course Memberships
Return active NamesAndRoleMemberships in the given course.
GET /lti/courses/{course_id}/names_and_roles - Read
List Group Memberships
Return active NamesAndRoleMemberships in the given group.
GET /lti/groups/{group_id}/names_and_roles
New Quiz Items
- Read
Get a quiz item
Get details about a single item in a new quiz.
GET /quiz/v1/courses/{course_id}/quizzes/{assignment_id}/items/{item_id} - Read
List quiz items
Get a list of items in a new quiz.
GET /quiz/v1/courses/{course_id}/quizzes/{assignment_id}/items - Read
Get items mediauploadurl
Get a url for uploading media for use in hot-spot question types. See the hot-spot question type in the {Appendix: Question Types} for more details about using this endpoint.
GET /quiz/v1/courses/{course_id}/quizzes/{assignment_id}/items/media_upload_url - Write
Create a quiz item
Create a quiz item in a new quiz. Only +QuestionItem+ types can be created.
POST /quiz/v1/courses/{course_id}/quizzes/{assignment_id}/items - Write
Update a quiz item
Update a single quiz item in a new quiz. Only +QuestionItem+ types can be updated.
PATCH /quiz/v1/courses/{course_id}/quizzes/{assignment_id}/items/{item_id} - Destructive
Delete a quiz item
Delete a single quiz item in a new quiz.
DELETE /quiz/v1/courses/{course_id}/quizzes/{assignment_id}/items/{item_id}
New Quizzes
- Read
Get a new quiz
Get details about a single new quiz.
GET /quiz/v1/courses/{course_id}/quizzes/{assignment_id} - Read
List new quizzes
Get a list of new quizzes.
GET /quiz/v1/courses/{course_id}/quizzes - Write
Create a new quiz
Create a new quiz for the course.
POST /quiz/v1/courses/{course_id}/quizzes - Write
Update a single quiz
Update a single quiz for the course.
PATCH /quiz/v1/courses/{course_id}/quizzes/{assignment_id} - Destructive
Delete a new quiz
Delete a single new quiz.
DELETE /quiz/v1/courses/{course_id}/quizzes/{assignment_id}
New Quizzes Accommodations
- Write
Set Quiz-Level Accommodations
Apply accommodations at the quiz level for students in a specific assignment. Request Body Format: [{ "userid": 3, "extratime": 60, "extraattempts": 1, "reducechoicesenabled": true }] Responses 200 OK : Accommodations were processed with some successes and failures 401 Unauthorized : User does not have permission to update accommodations 404 Not Found : The course or assignment was not found 400 Bad Request : Validation error (e.g., invalid JSON, missing user IDs)
POST /quiz/v1/courses/{course_id}/quizzes/{assignment_id}/accommodations - Write
Set Course-Level Accommodations
Apply accommodations at the course level for students enrolled in a given course. Request Body Format: [{ "userid": 3, "extratime": 60, "applytoinprogressquizsessions": true, "reducechoicesenabled": true }] Responses 200 OK : Accommodations were processed with some successes and failures 401 Unauthorized : User does not have permission to update accommodations 404 Not Found : The course was not found 400 Bad Request : Validation error (e.g., invalid JSON, missing user IDs)
POST /quiz/v1/courses/{course_id}/accommodations
New Quizzes Reports
- Write
Create a quiz report
Generate a new report for this quiz. Returns a progress object that can be used to track the progress of the report generation. Responses 400 Bad Request if the specified report type or format is invalid 409 Conflict if a quiz report of the specified type is already being generated
POST /quiz/v1/courses/{course_id}/quizzes/{assignment_id}/reports
Notice Handlers
- Read
Show notice handlers
List all notice handlers for the tool
GET /lti/notice-handlers/{context_external_tool_id} - Destructive
Set notice handler
Subscribe (set) or unsubscribe (remove) a notice handler for the tool
PUT /lti/notice-handlers/{context_external_tool_id}
Notification Preferences
- Read
List preferences
Fetch all preferences for the given communication channel
GET /v1/users/{user_id}/communication_channels/{communication_channel_id}/notification_preferences - Read
List preferences
Fetch all preferences for the given communication channel
GET /v1/users/{user_id}/communication_channels/{type}/{address}/notification_preferences - Read
List of preference categories
Fetch all notification preference categories for the given communication channel
GET /v1/users/{user_id}/communication_channels/{communication_channel_id}/notification_preference_categories - Read
Get a preference
Fetch the preference for the given notification for the given communication channel
GET /v1/users/{user_id}/communication_channels/{communication_channel_id}/notification_preferences/{notification} - Read
Get a preference
Fetch the preference for the given notification for the given communication channel
GET /v1/users/{user_id}/communication_channels/{type}/{address}/notification_preferences/{notification} - Destructive
Update a preference
Change the preference for a single notification for a single communication channel
PUT /v1/users/self/communication_channels/{communication_channel_id}/notification_preferences/{notification} - Destructive
Update a preference
Change the preference for a single notification for a single communication channel
PUT /v1/users/self/communication_channels/{type}/{address}/notification_preferences/{notification} - Destructive
Update preferences by category
Change the preferences for multiple notifications based on the category for a single communication channel
PUT /v1/users/self/communication_channels/{communication_channel_id}/notification_preference_categories/{category} - Destructive
Update multiple preferences
Change the preferences for multiple notifications for a single communication channel at once
PUT /v1/users/self/communication_channels/{communication_channel_id}/notification_preferences - Destructive
Update multiple preferences
Change the preferences for multiple notifications for a single communication channel at once
PUT /v1/users/self/communication_channels/{type}/{address}/notification_preferences
Originality Reports
- Read
Show an Originality Report
Get a single originality report
GET /lti/assignments/{assignment_id}/submissions/{submission_id}/originality_report/{id} - Read
Show an Originality Report
Get a single originality report
GET /lti/assignments/{assignment_id}/files/{file_id}/originality_report - Write
Create an Originality Report
Create a new OriginalityReport for the specified file
POST /lti/assignments/{assignment_id}/submissions/{submission_id}/originality_report - Destructive
Edit an Originality Report
Modify an existing originality report. An alternative to this endpoint is to POST the same parameters listed below to the CREATE endpoint.
PUT /lti/assignments/{assignment_id}/submissions/{submission_id}/originality_report/{id} - Destructive
Edit an Originality Report
Modify an existing originality report. An alternative to this endpoint is to POST the same parameters listed below to the CREATE endpoint.
PUT /lti/assignments/{assignment_id}/files/{file_id}/originality_report
Outcome Groups
- Read
Redirect to root outcome group for context
Convenience redirect to find the root outcome group for a particular context. Will redirect to the appropriate outcome group's URL.
GET /v1/global/root_outcome_group - Read
Redirect to root outcome group for context
Convenience redirect to find the root outcome group for a particular context. Will redirect to the appropriate outcome group's URL.
GET /v1/accounts/{account_id}/root_outcome_group - Read
Redirect to root outcome group for context
Convenience redirect to find the root outcome group for a particular context. Will redirect to the appropriate outcome group's URL.
GET /v1/courses/{course_id}/root_outcome_group - Read
Get all outcome groups for context
Returns a list of all outcome groups in the specified context.
GET /v1/accounts/{account_id}/outcome_groups - Read
Get all outcome groups for context
Returns a list of all outcome groups in the specified context.
GET /v1/courses/{course_id}/outcome_groups - Read
Get all outcome links for context
Returns a list of all outcome links in the specified context.
GET /v1/accounts/{account_id}/outcome_group_links - Read
Get all outcome links for context
Returns a list of all outcome links in the specified context.
GET /v1/courses/{course_id}/outcome_group_links - Read
Show an outcome group
Returns detailed information about a specific outcome group.
GET /v1/global/outcome_groups/{id} - Read
Show an outcome group
Returns detailed information about a specific outcome group.
GET /v1/accounts/{account_id}/outcome_groups/{id} - Read
Show an outcome group
Returns detailed information about a specific outcome group.
GET /v1/courses/{course_id}/outcome_groups/{id} - Read
List linked outcomes
A paginated list of the immediate OutcomeLink children of the outcome group.
GET /v1/global/outcome_groups/{id}/outcomes - Read
List linked outcomes
A paginated list of the immediate OutcomeLink children of the outcome group.
GET /v1/accounts/{account_id}/outcome_groups/{id}/outcomes - Read
List linked outcomes
A paginated list of the immediate OutcomeLink children of the outcome group.
GET /v1/courses/{course_id}/outcome_groups/{id}/outcomes - Read
List subgroups
A paginated list of the immediate OutcomeGroup children of the outcome group.
GET /v1/global/outcome_groups/{id}/subgroups - Read
List subgroups
A paginated list of the immediate OutcomeGroup children of the outcome group.
GET /v1/accounts/{account_id}/outcome_groups/{id}/subgroups - Read
List subgroups
A paginated list of the immediate OutcomeGroup children of the outcome group.
GET /v1/courses/{course_id}/outcome_groups/{id}/subgroups - Write
Create/link an outcome
Link an outcome into the outcome group. The outcome to link can either be specified by a PUT to the link URL for a specific outcome (the outcomeid in the PUT URLs) or by supplying the information for a new outcome (title, description, ratings, masterypoints) in a POST to the collection. If linking an existing outcome, the outcomeid must identify an outcome available to this context; i.e. an outcome owned by this group's context, an outcome owned by an associated account, or a global outcome. With outcomeid present, any other parameters (except movefrom) are ignored. If defining a new outcome, the outcome is created in the outcome group's context using the provided title, description, ratings, and mastery points; the title is required but all other fields are optional. The new outcome is then linked into the outcome group. If ratings are provided when creating a new outcome, an embedded rubric criterion is included in the new outcome. This criterion's masterypoints default to the maximum points in the highest rating if not specified in the masterypoints parameter. Any ratings lacking a description are given a default of "No description". Any ratings lacking a point value are given a default of 0. If no ratings are provided, the masterypoints parameter is ignored.
POST /v1/global/outcome_groups/{id}/outcomes - Write
Create/link an outcome
Link an outcome into the outcome group. The outcome to link can either be specified by a PUT to the link URL for a specific outcome (the outcomeid in the PUT URLs) or by supplying the information for a new outcome (title, description, ratings, masterypoints) in a POST to the collection. If linking an existing outcome, the outcomeid must identify an outcome available to this context; i.e. an outcome owned by this group's context, an outcome owned by an associated account, or a global outcome. With outcomeid present, any other parameters (except movefrom) are ignored. If defining a new outcome, the outcome is created in the outcome group's context using the provided title, description, ratings, and mastery points; the title is required but all other fields are optional. The new outcome is then linked into the outcome group. If ratings are provided when creating a new outcome, an embedded rubric criterion is included in the new outcome. This criterion's masterypoints default to the maximum points in the highest rating if not specified in the masterypoints parameter. Any ratings lacking a description are given a default of "No description". Any ratings lacking a point value are given a default of 0. If no ratings are provided, the masterypoints parameter is ignored.
POST /v1/accounts/{account_id}/outcome_groups/{id}/outcomes - Write
Create/link an outcome
Link an outcome into the outcome group. The outcome to link can either be specified by a PUT to the link URL for a specific outcome (the outcomeid in the PUT URLs) or by supplying the information for a new outcome (title, description, ratings, masterypoints) in a POST to the collection. If linking an existing outcome, the outcomeid must identify an outcome available to this context; i.e. an outcome owned by this group's context, an outcome owned by an associated account, or a global outcome. With outcomeid present, any other parameters (except movefrom) are ignored. If defining a new outcome, the outcome is created in the outcome group's context using the provided title, description, ratings, and mastery points; the title is required but all other fields are optional. The new outcome is then linked into the outcome group. If ratings are provided when creating a new outcome, an embedded rubric criterion is included in the new outcome. This criterion's masterypoints default to the maximum points in the highest rating if not specified in the masterypoints parameter. Any ratings lacking a description are given a default of "No description". Any ratings lacking a point value are given a default of 0. If no ratings are provided, the masterypoints parameter is ignored.
POST /v1/courses/{course_id}/outcome_groups/{id}/outcomes - Write
Create a subgroup
Creates a new empty subgroup under the outcome group with the given title and description.
POST /v1/global/outcome_groups/{id}/subgroups - Write
Create a subgroup
Creates a new empty subgroup under the outcome group with the given title and description.
POST /v1/accounts/{account_id}/outcome_groups/{id}/subgroups - Write
Create a subgroup
Creates a new empty subgroup under the outcome group with the given title and description.
POST /v1/courses/{course_id}/outcome_groups/{id}/subgroups - Write
Import an outcome group
Creates a new subgroup of the outcome group with the same title and description as the source group, then creates links in that new subgroup to the same outcomes that are linked in the source group. Recurses on the subgroups of the source group, importing them each in turn into the new subgroup. Allows you to copy organizational structure, but does not create copies of the outcomes themselves, only new links. The source group must be either global, from the same context as this outcome group, or from an associated account. The source group cannot be the root outcome group of its context.
POST /v1/global/outcome_groups/{id}/import - Write
Import an outcome group
Creates a new subgroup of the outcome group with the same title and description as the source group, then creates links in that new subgroup to the same outcomes that are linked in the source group. Recurses on the subgroups of the source group, importing them each in turn into the new subgroup. Allows you to copy organizational structure, but does not create copies of the outcomes themselves, only new links. The source group must be either global, from the same context as this outcome group, or from an associated account. The source group cannot be the root outcome group of its context.
POST /v1/accounts/{account_id}/outcome_groups/{id}/import - Write
Import an outcome group
Creates a new subgroup of the outcome group with the same title and description as the source group, then creates links in that new subgroup to the same outcomes that are linked in the source group. Recurses on the subgroups of the source group, importing them each in turn into the new subgroup. Allows you to copy organizational structure, but does not create copies of the outcomes themselves, only new links. The source group must be either global, from the same context as this outcome group, or from an associated account. The source group cannot be the root outcome group of its context.
POST /v1/courses/{course_id}/outcome_groups/{id}/import - Destructive
Update an outcome group
Modify an existing outcome group. Fields not provided are left as is; unrecognized fields are ignored. When changing the parent outcome group, the new parent group must belong to the same context as this outcome group, and must not be a descendant of this outcome group (i.e. no cycles allowed).
PUT /v1/global/outcome_groups/{id} - Destructive
Update an outcome group
Modify an existing outcome group. Fields not provided are left as is; unrecognized fields are ignored. When changing the parent outcome group, the new parent group must belong to the same context as this outcome group, and must not be a descendant of this outcome group (i.e. no cycles allowed).
PUT /v1/accounts/{account_id}/outcome_groups/{id} - Destructive
Update an outcome group
Modify an existing outcome group. Fields not provided are left as is; unrecognized fields are ignored. When changing the parent outcome group, the new parent group must belong to the same context as this outcome group, and must not be a descendant of this outcome group (i.e. no cycles allowed).
PUT /v1/courses/{course_id}/outcome_groups/{id} - Destructive
Delete an outcome group
Deleting an outcome group deletes descendant outcome groups and outcome links. The linked outcomes themselves are only deleted if all links to the outcome were deleted. Aligned outcomes cannot be deleted; as such, if all remaining links to an aligned outcome are included in this group's descendants, the group deletion will fail.
DELETE /v1/global/outcome_groups/{id} - Destructive
Delete an outcome group
Deleting an outcome group deletes descendant outcome groups and outcome links. The linked outcomes themselves are only deleted if all links to the outcome were deleted. Aligned outcomes cannot be deleted; as such, if all remaining links to an aligned outcome are included in this group's descendants, the group deletion will fail.
DELETE /v1/accounts/{account_id}/outcome_groups/{id} - Destructive
Delete an outcome group
Deleting an outcome group deletes descendant outcome groups and outcome links. The linked outcomes themselves are only deleted if all links to the outcome were deleted. Aligned outcomes cannot be deleted; as such, if all remaining links to an aligned outcome are included in this group's descendants, the group deletion will fail.
DELETE /v1/courses/{course_id}/outcome_groups/{id} - Destructive
Create/link an outcome
Link an outcome into the outcome group. The outcome to link can either be specified by a PUT to the link URL for a specific outcome (the outcomeid in the PUT URLs) or by supplying the information for a new outcome (title, description, ratings, masterypoints) in a POST to the collection. If linking an existing outcome, the outcomeid must identify an outcome available to this context; i.e. an outcome owned by this group's context, an outcome owned by an associated account, or a global outcome. With outcomeid present, any other parameters (except movefrom) are ignored. If defining a new outcome, the outcome is created in the outcome group's context using the provided title, description, ratings, and mastery points; the title is required but all other fields are optional. The new outcome is then linked into the outcome group. If ratings are provided when creating a new outcome, an embedded rubric criterion is included in the new outcome. This criterion's masterypoints default to the maximum points in the highest rating if not specified in the masterypoints parameter. Any ratings lacking a description are given a default of "No description". Any ratings lacking a point value are given a default of 0. If no ratings are provided, the masterypoints parameter is ignored.
PUT /v1/global/outcome_groups/{id}/outcomes/{outcome_id} - Destructive
Create/link an outcome
Link an outcome into the outcome group. The outcome to link can either be specified by a PUT to the link URL for a specific outcome (the outcomeid in the PUT URLs) or by supplying the information for a new outcome (title, description, ratings, masterypoints) in a POST to the collection. If linking an existing outcome, the outcomeid must identify an outcome available to this context; i.e. an outcome owned by this group's context, an outcome owned by an associated account, or a global outcome. With outcomeid present, any other parameters (except movefrom) are ignored. If defining a new outcome, the outcome is created in the outcome group's context using the provided title, description, ratings, and mastery points; the title is required but all other fields are optional. The new outcome is then linked into the outcome group. If ratings are provided when creating a new outcome, an embedded rubric criterion is included in the new outcome. This criterion's masterypoints default to the maximum points in the highest rating if not specified in the masterypoints parameter. Any ratings lacking a description are given a default of "No description". Any ratings lacking a point value are given a default of 0. If no ratings are provided, the masterypoints parameter is ignored.
PUT /v1/accounts/{account_id}/outcome_groups/{id}/outcomes/{outcome_id} - Destructive
Create/link an outcome
Link an outcome into the outcome group. The outcome to link can either be specified by a PUT to the link URL for a specific outcome (the outcomeid in the PUT URLs) or by supplying the information for a new outcome (title, description, ratings, masterypoints) in a POST to the collection. If linking an existing outcome, the outcomeid must identify an outcome available to this context; i.e. an outcome owned by this group's context, an outcome owned by an associated account, or a global outcome. With outcomeid present, any other parameters (except movefrom) are ignored. If defining a new outcome, the outcome is created in the outcome group's context using the provided title, description, ratings, and mastery points; the title is required but all other fields are optional. The new outcome is then linked into the outcome group. If ratings are provided when creating a new outcome, an embedded rubric criterion is included in the new outcome. This criterion's masterypoints default to the maximum points in the highest rating if not specified in the masterypoints parameter. Any ratings lacking a description are given a default of "No description". Any ratings lacking a point value are given a default of 0. If no ratings are provided, the masterypoints parameter is ignored.
PUT /v1/courses/{course_id}/outcome_groups/{id}/outcomes/{outcome_id} - Destructive
Unlink an outcome
Unlinking an outcome only deletes the outcome itself if this was the last link to the outcome in any group in any context. Aligned outcomes cannot be deleted; as such, if this is the last link to an aligned outcome, the unlinking will fail.
DELETE /v1/global/outcome_groups/{id}/outcomes/{outcome_id} - Destructive
Unlink an outcome
Unlinking an outcome only deletes the outcome itself if this was the last link to the outcome in any group in any context. Aligned outcomes cannot be deleted; as such, if this is the last link to an aligned outcome, the unlinking will fail.
DELETE /v1/accounts/{account_id}/outcome_groups/{id}/outcomes/{outcome_id} - Destructive
Unlink an outcome
Unlinking an outcome only deletes the outcome itself if this was the last link to the outcome in any group in any context. Aligned outcomes cannot be deleted; as such, if this is the last link to an aligned outcome, the unlinking will fail.
DELETE /v1/courses/{course_id}/outcome_groups/{id}/outcomes/{outcome_id}
Outcome Imports
- Read
Get Outcome import status
Get the status of an already created Outcome import. Pass 'latest' for the outcome import id for the latest import. Examples: curl 'https:// /api/v1/accounts/ /outcomeimports/ ' \ -H "Authorization: Bearer " curl 'https:// /api/v1/courses/ /outcomeimports/ ' \ -H "Authorization: Bearer "
GET /v1/accounts/{account_id}/outcome_imports/{id} - Read
Get Outcome import status
Get the status of an already created Outcome import. Pass 'latest' for the outcome import id for the latest import. Examples: curl 'https:// /api/v1/accounts/ /outcomeimports/ ' \ -H "Authorization: Bearer " curl 'https:// /api/v1/courses/ /outcomeimports/ ' \ -H "Authorization: Bearer "
GET /v1/courses/{course_id}/outcome_imports/{id} - Read
Get IDs of outcome groups created after successful import
Get the IDs of the outcome groups created after a successful import. Pass 'latest' for the outcome import id for the latest import. Examples: curl 'https:// /api/v1/accounts/ /outcomeimports/outcomesgroupids/ ' \ -H "Authorization: Bearer " curl 'https:// /api/v1/courses/ /outcomeimports/outcomegroupids/ ' \ -H "Authorization: Bearer "
GET /v1/accounts/{account_id}/outcome_imports/{id}/created_group_ids - Read
Get IDs of outcome groups created after successful import
Get the IDs of the outcome groups created after a successful import. Pass 'latest' for the outcome import id for the latest import. Examples: curl 'https:// /api/v1/accounts/ /outcomeimports/outcomesgroupids/ ' \ -H "Authorization: Bearer " curl 'https:// /api/v1/courses/ /outcomeimports/outcomegroupids/ ' \ -H "Authorization: Bearer "
GET /v1/courses/{course_id}/outcome_imports/{id}/created_group_ids - Write
Import Outcomes
Import outcomes into Canvas. For more information on the format that's expected here, please see the "Outcomes CSV" section in the API docs.
POST /v1/accounts/{account_id}/outcome_imports - Write
Import Outcomes
Import outcomes into Canvas. For more information on the format that's expected here, please see the "Outcomes CSV" section in the API docs.
POST /v1/courses/{course_id}/outcome_imports
Outcome Results
- Read
Get outcome results
Gets the outcome results for users and outcomes in the specified context. used in sLMGB
GET /v1/courses/{course_id}/outcome_results - Read
Get outcome result rollups
Gets the outcome rollups for the users and outcomes in the specified context.
GET /v1/courses/{course_id}/outcome_rollups - Read
Get contributing scores
Gets the contributing scores for a specific outcome and set of users. Contributing scores are the individual assignment/quiz scores that contributed to the outcome score for each user. Returns all alignments for the outcome in the course context.
GET /v1/courses/{course_id}/outcomes/{outcome_id}/contributing_scores - Read
Get mastery distribution
Returns the distribution of student scores across mastery levels for all outcomes. This endpoint fetches data for ALL students (not paginated) to provide accurate distribution statistics for charts and analytics. Accepts GET or POST.
GET /v1/courses/{course_id}/outcome_mastery_distribution - Write
Set outcome ordering for LMGB
Saves the ordering of outcomes in LMGB for a user
POST /v1/courses/{course_id}/assign_outcome_order - Write
Enqueue a delayed Outcome Rollup Calculation Job
Enqueue a delayed Outcome Rollup Calculation Job
POST /v1/courses/{course_id}/enqueue_outcome_rollup_calculation
Outcomes
- Read
Show an outcome
Returns the details of the outcome with the given id.
GET /v1/outcomes/{id} - Read
Get outcome alignments for a student or assignment
Returns outcome alignments for a student or assignment in a course.
GET /v1/courses/{course_id}/outcome_alignments - Destructive
Update an outcome
Modify an existing outcome. Fields not provided are left as is; unrecognized fields are ignored. If any new ratings are provided, the combination of all new ratings provided completely replace any existing embedded rubric criterion; it is not possible to tweak the ratings of the embedded rubric criterion. A new embedded rubric criterion's masterypoints default to the maximum points in the highest rating if not specified in the masterypoints parameter. Any new ratings lacking a description are given a default of "No description". Any new ratings lacking a point value are given a default of 0.
PUT /v1/outcomes/{id}
Pages
- Read
Show front page
Retrieve the content of the front page
GET /v1/courses/{course_id}/front_page - Read
Show front page
Retrieve the content of the front page
GET /v1/groups/{group_id}/front_page - Read
List pages
A paginated list of the wiki pages associated with a course or group
GET /v1/courses/{course_id}/pages - Read
List pages
A paginated list of the wiki pages associated with a course or group
GET /v1/groups/{group_id}/pages - Read
Show page
Retrieve the content of a wiki page
GET /v1/courses/{course_id}/pages/{url_or_id} - Read
Show page
Retrieve the content of a wiki page
GET /v1/groups/{group_id}/pages/{url_or_id} - Read
List revisions
A paginated list of the revisions of a page. Callers must have update rights on the page in order to see page history.
GET /v1/courses/{course_id}/pages/{url_or_id}/revisions - Read
List revisions
A paginated list of the revisions of a page. Callers must have update rights on the page in order to see page history.
GET /v1/groups/{group_id}/pages/{url_or_id}/revisions - Read
Show revision
Retrieve the metadata and optionally content of a revision of the page. Note that retrieving historic versions of pages requires edit rights.
GET /v1/courses/{course_id}/pages/{url_or_id}/revisions/latest - Read
Show revision
Retrieve the metadata and optionally content of a revision of the page. Note that retrieving historic versions of pages requires edit rights.
GET /v1/groups/{group_id}/pages/{url_or_id}/revisions/latest - Read
Show revision
Retrieve the metadata and optionally content of a revision of the page. Note that retrieving historic versions of pages requires edit rights.
GET /v1/courses/{course_id}/pages/{url_or_id}/revisions/{revision_id} - Read
Show revision
Retrieve the metadata and optionally content of a revision of the page. Note that retrieving historic versions of pages requires edit rights.
GET /v1/groups/{group_id}/pages/{url_or_id}/revisions/{revision_id} - Write
Duplicate page
Duplicate a wiki page
POST /v1/courses/{course_id}/pages/{url_or_id}/duplicate - Write
Create page
Create a new wiki page
POST /v1/courses/{course_id}/pages - Write
Create page
Create a new wiki page
POST /v1/groups/{group_id}/pages - Write
Revert to revision
Revert a page to a prior revision.
POST /v1/courses/{course_id}/pages/{url_or_id}/revisions/{revision_id} - Write
Revert to revision
Revert a page to a prior revision.
POST /v1/groups/{group_id}/pages/{url_or_id}/revisions/{revision_id} - Destructive
Update/create front page
Update the title or contents of the front page
PUT /v1/courses/{course_id}/front_page - Destructive
Update/create front page
Update the title or contents of the front page
PUT /v1/groups/{group_id}/front_page - Destructive
Update/create page
Update the title or contents of a wiki page NOTE: You cannot specify the ID when creating a page. If you pass a numeric value as the page identifier and that does not represent a page ID that already exists, it will be interpreted as a URL.
PUT /v1/courses/{course_id}/pages/{url_or_id} - Destructive
Update/create page
Update the title or contents of a wiki page NOTE: You cannot specify the ID when creating a page. If you pass a numeric value as the page identifier and that does not represent a page ID that already exists, it will be interpreted as a URL.
PUT /v1/groups/{group_id}/pages/{url_or_id} - Destructive
Delete page
Delete a wiki page
DELETE /v1/courses/{course_id}/pages/{url_or_id} - Destructive
Delete page
Delete a wiki page
DELETE /v1/groups/{group_id}/pages/{url_or_id}
Peer Reviews
- Read
Get all Peer Reviews
Get a list of all Peer Reviews for this assignment
GET /v1/courses/{course_id}/assignments/{assignment_id}/peer_reviews - Read
Get all Peer Reviews
Get a list of all Peer Reviews for this assignment
GET /v1/sections/{section_id}/assignments/{assignment_id}/peer_reviews - Read
Get all Peer Reviews
Get a list of all Peer Reviews for this assignment
GET /v1/courses/{course_id}/assignments/{assignment_id}/submissions/{submission_id}/peer_reviews - Read
Get all Peer Reviews
Get a list of all Peer Reviews for this assignment
GET /v1/sections/{section_id}/assignments/{assignment_id}/submissions/{submission_id}/peer_reviews - Write
Create Peer Review
Create a peer review for the assignment
POST /v1/courses/{course_id}/assignments/{assignment_id}/submissions/{submission_id}/peer_reviews - Write
Create Peer Review
Create a peer review for the assignment
POST /v1/sections/{section_id}/assignments/{assignment_id}/submissions/{submission_id}/peer_reviews - Write
Allocate Peer Review
Allocates a submission for the current user to peer review
POST /v1/courses/{course_id}/assignments/{assignment_id}/allocate - Destructive
Delete Peer Review
Delete a peer review for the assignment
DELETE /v1/courses/{course_id}/assignments/{assignment_id}/submissions/{submission_id}/peer_reviews - Destructive
Delete Peer Review
Delete a peer review for the assignment
DELETE /v1/sections/{section_id}/assignments/{assignment_id}/submissions/{submission_id}/peer_reviews
Plagiarism Detection Platform Assignments
- Read
Get a single assignment (lti)
Get a single Canvas assignment by Canvas id or LTI id. Tool providers may only access assignments that are associated with their tool.
GET /lti/assignments/{assignment_id}
Plagiarism Detection Platform Users
- Read
Get a single user (lti)
Get a single Canvas user by Canvas id or LTI id. Tool providers may only access users that have been assigned an assignment associated with their tool.
GET /lti/users/{id} - Read
Get all users in a group (lti)
Get all Canvas users in a group. Tool providers may only access groups that belong to the context the tool is installed in.
GET /lti/groups/{group_id}/users
Plagiarism Detection Submissions
- Read
Get a single submission
Get a single submission, based on submission id.
GET /lti/assignments/{assignment_id}/submissions/{submission_id} - Read
Get the history of a single submission
Get a list of all attempts made for a submission, based on submission id.
GET /lti/assignments/{assignment_id}/submissions/{submission_id}/history
Planner
- Read
List planner items
Retrieve the paginated list of objects to be shown on the planner for the current user with the associated planner override to override an item's visibility if set. Planner items for a student may also be retrieved by a linked observer. Use the path that accepts a userid and supply the student's id.
GET /v1/planner/items - Read
List planner items
Retrieve the paginated list of objects to be shown on the planner for the current user with the associated planner override to override an item's visibility if set. Planner items for a student may also be retrieved by a linked observer. Use the path that accepts a userid and supply the student's id.
GET /v1/users/{user_id}/planner/items - Read
List planner notes
Retrieve the paginated list of planner notes Retrieve planner note for a user
GET /v1/planner_notes - Read
Show a planner note
Retrieve a planner note for the current user
GET /v1/planner_notes/{id} - Read
List planner overrides
Retrieve a planner override for the current user
GET /v1/planner/overrides - Read
Show a planner override
Retrieve a planner override for the current user
GET /v1/planner/overrides/{id} - Write
Create a planner note
Create a planner note for the current user
POST /v1/planner_notes - Write
Create a planner override
Create a planner override for the current user
POST /v1/planner/overrides - Destructive
Update a planner note
Update a planner note for the current user
PUT /v1/planner_notes/{id} - Destructive
Delete a planner note
Delete a planner note for the current user
DELETE /v1/planner_notes/{id} - Destructive
Update a planner override
Update a planner override's visibilty for the current user
PUT /v1/planner/overrides/{id} - Destructive
Delete a planner override
Delete a planner override for the current user
DELETE /v1/planner/overrides/{id}
Poll Sessions
- Read
List poll sessions for a poll
Returns the paginated list of PollSessions in this poll.
GET /v1/polls/{poll_id}/poll_sessions - Read
Get the results for a single poll session
Returns the poll session with the given id
GET /v1/polls/{poll_id}/poll_sessions/{id} - Read
Open a poll session
Open a poll session
GET /v1/polls/{poll_id}/poll_sessions/{id}/open - Read
Close an opened poll session
Close an opened poll session
GET /v1/polls/{poll_id}/poll_sessions/{id}/close - Read
List opened poll sessions
A paginated list of all opened poll sessions available to the current user.
GET /v1/poll_sessions/opened - Read
List closed poll sessions
A paginated list of all closed poll sessions available to the current user.
GET /v1/poll_sessions/closed - Write
Create a single poll session
Create a new poll session for this poll
POST /v1/polls/{poll_id}/poll_sessions - Destructive
Update a single poll session
Update an existing poll session for this poll
PUT /v1/polls/{poll_id}/poll_sessions/{id} - Destructive
Delete a poll session
204 No Content response code is returned if the deletion was successful.
DELETE /v1/polls/{poll_id}/poll_sessions/{id}
PollChoices
- Read
List poll choices in a poll
Returns the paginated list of PollChoices in this poll.
GET /v1/polls/{poll_id}/poll_choices - Read
Get a single poll choice
Returns the poll choice with the given id
GET /v1/polls/{poll_id}/poll_choices/{id} - Write
Create a single poll choice
Create a new poll choice for this poll
POST /v1/polls/{poll_id}/poll_choices - Destructive
Update a single poll choice
Update an existing poll choice for this poll
PUT /v1/polls/{poll_id}/poll_choices/{id} - Destructive
Delete a poll choice
204 No Content response code is returned if the deletion was successful.
DELETE /v1/polls/{poll_id}/poll_choices/{id}
Polls
- Read
List polls
Returns the paginated list of polls for the current user.
GET /v1/polls - Read
Get a single poll
Returns the poll with the given id
GET /v1/polls/{id} - Write
Create a single poll
Create a new poll for the current user
POST /v1/polls - Destructive
Update a single poll
Update an existing poll belonging to the current user
PUT /v1/polls/{id} - Destructive
Delete a poll
204 No Content response code is returned if the deletion was successful.
DELETE /v1/polls/{id}
PollSubmissions
- Read
Get a single poll submission
Returns the poll submission with the given id
GET /v1/polls/{poll_id}/poll_sessions/{poll_session_id}/poll_submissions/{id} - Write
Create a single poll submission
Create a new poll submission for this poll session
POST /v1/polls/{poll_id}/poll_sessions/{poll_session_id}/poll_submissions
Portfolio Notifications
- Write
Create a portfolio notification
Create a portfolio notification
POST /v1/users/{user_id}/portfolio_notifications
Proficiency Ratings
- Read
Get proficiency ratings
Get account-level proficiency ratings. If not defined for this account, it will return proficiency ratings for the nearest super-account with ratings defined. Will return 404 if none found. Examples: curl https:// /api/v1/accounts/ /outcomeproficiency \ -H 'Authorization: Bearer '
GET /v1/accounts/{account_id}/outcome_proficiency - Read
Get proficiency ratings
Get account-level proficiency ratings. If not defined for this account, it will return proficiency ratings for the nearest super-account with ratings defined. Will return 404 if none found. Examples: curl https:// /api/v1/accounts/ /outcomeproficiency \ -H 'Authorization: Bearer '
GET /v1/courses/{course_id}/outcome_proficiency - Write
Create/update proficiency ratings
Create or update account-level proficiency ratings. These ratings will apply to all sub-accounts, unless they have their own account-level proficiency ratings defined.
POST /v1/accounts/{account_id}/outcome_proficiency - Write
Create/update proficiency ratings
Create or update account-level proficiency ratings. These ratings will apply to all sub-accounts, unless they have their own account-level proficiency ratings defined.
POST /v1/courses/{course_id}/outcome_proficiency
Progress
- Read
Query progress
Return completion and status information about an asynchronous job
GET /v1/progress/{id} - Read
Query progress
Return completion and status information about an asynchronous job
GET /lti/courses/{course_id}/progress/{id} - Destructive
Cancel progress
Cancel an asynchronous job associated with a Progress object If you include "message" in the POSTed data, it will be set on the Progress and returned. This is handy to distinguish between cancel and fail for a workflowstate of "failed".
POST /v1/progress/{id}/cancel
Public JWK
- Destructive
Update Public JWK
Rotate the public key in jwk format when using lti services
PUT /lti/developer_key/update_public_jwk
Quiz Assignment Overrides
- Read
Retrieve assignment-overridden dates for Classic Quizzes
Retrieve the actual due-at, unlock-at, and available-at dates for quizzes based on the assignment overrides active for the current API user.
GET /v1/courses/{course_id}/quizzes/assignment_overrides - Read
Retrieve assignment-overridden dates for New Quizzes
Retrieve the actual due-at, unlock-at, and available-at dates for quizzes based on the assignment overrides active for the current API user.
GET /v1/courses/{course_id}/new_quizzes/assignment_overrides
Quiz Extensions
- Write
Set extensions for student quiz submissions
Responses 200 OK if the request was successful 403 Forbidden if you are not allowed to extend quizzes for this course
POST /v1/courses/{course_id}/quizzes/{quiz_id}/extensions
Quiz IP Filters
- Read
Get available quiz IP filters.
Get a list of available IP filters for this Quiz. 200 OK response code is returned if the request was successful.
GET /v1/courses/{course_id}/quizzes/{quiz_id}/ip_filters
Quiz Question Groups
- Read
List question groups in a quiz
Returns a list of question groups in a quiz.
GET /v1/courses/{course_id}/quizzes/{quiz_id}/groups - Read
Get a single quiz group
Returns details of the quiz group with the given id.
GET /v1/courses/{course_id}/quizzes/{quiz_id}/groups/{id} - Write
Create a question group
Create a new question group for this quiz 201 Created response code is returned if the creation was successful.
POST /v1/courses/{course_id}/quizzes/{quiz_id}/groups - Write
Reorder question groups
Change the order of the quiz questions within the group 204 No Content response code is returned if the reorder was successful.
POST /v1/courses/{course_id}/quizzes/{quiz_id}/groups/{id}/reorder - Destructive
Update a question group
Update a question group
PUT /v1/courses/{course_id}/quizzes/{quiz_id}/groups/{id} - Destructive
Delete a question group
Delete a question group 204 No Content response code is returned if the deletion was successful.
DELETE /v1/courses/{course_id}/quizzes/{quiz_id}/groups/{id}
Quiz Questions
- Read
List questions in a quiz or a submission
Returns the paginated list of QuizQuestions in this quiz.
GET /v1/courses/{course_id}/quizzes/{quiz_id}/questions - Read
Get a single quiz question
Returns the quiz question with the given id
GET /v1/courses/{course_id}/quizzes/{quiz_id}/questions/{id} - Write
Create a single quiz question
Create a new quiz question for this quiz
POST /v1/courses/{course_id}/quizzes/{quiz_id}/questions - Destructive
Update an existing quiz question
Updates an existing quiz question for this quiz
PUT /v1/courses/{course_id}/quizzes/{quiz_id}/questions/{id} - Destructive
Delete a quiz question
204 No Content response code is returned if the deletion was successful.
DELETE /v1/courses/{course_id}/quizzes/{quiz_id}/questions/{id}
Quiz Reports
- Read
Retrieve all quiz reports
Returns a list of all available reports.
GET /v1/courses/{course_id}/quizzes/{quiz_id}/reports - Read
Get a quiz report
Returns the data for a single quiz report.
GET /v1/courses/{course_id}/quizzes/{quiz_id}/reports/{id} - Write
Create a quiz report
Create and return a new report for this quiz. If a previously generated report matches the arguments and is still current (i.e. there have been no new submissions), it will be returned. Responses 400 Bad Request if the specified report type is invalid 409 Conflict if a quiz report of the specified type is already being generated
POST /v1/courses/{course_id}/quizzes/{quiz_id}/reports - Destructive
Abort the generation of a report, or remove a previously generated one
This API allows you to cancel a previous request you issued for a report to be generated. Or in the case of an already generated report, you'd like to remove it, perhaps to generate it another time with an updated version that provides new features. You must check the report's generation status before attempting to use this interface. See the "workflowstate" property of the QuizReport's Progress object for more information. Only when the progress reports itself in a "queued" state can the generation be aborted. Responses - 204 No Content if your request was accepted - 422 Unprocessable Entity if the report is not being generated or can not be aborted at this stage
DELETE /v1/courses/{course_id}/quizzes/{quiz_id}/reports/{id}
Quiz Statistics
- Read
Fetching the latest quiz statistics
This endpoint provides statistics for all quiz versions, or for a specific quiz version, in which case the output is guaranteed to represent the latest and most current version of the quiz. 200 OK response code is returned if the request was successful.
GET /v1/courses/{course_id}/quizzes/{quiz_id}/statistics
Quiz Submission Events
- Read
Retrieve captured events
Retrieve the set of events captured during a specific submission attempt.
GET /v1/courses/{course_id}/quizzes/{quiz_id}/submissions/{id}/events - Write
Submit captured events
Store a set of events which were captured during a quiz taking session. On success, the response will be 204 No Content with an empty body.
POST /v1/courses/{course_id}/quizzes/{quiz_id}/submissions/{id}/events
Quiz Submission Files
- Write
Upload a file
Associate a new quiz submission file This API endpoint is the first step in uploading a quiz submission file. See the {file:file.fileuploads.html File Upload Documentation} for details on the file upload workflow as these parameters are interpreted as per the documentation there.
POST /v1/courses/{course_id}/quizzes/{quiz_id}/submissions/self/files
Quiz Submission Questions
- Read
Get all quiz submission questions.
Get a list of all the question records for this quiz submission. 200 OK response code is returned if the request was successful.
GET /v1/quiz_submissions/{quiz_submission_id}/questions - Read
Get a formatted student numerical answer.
Matches the intended behavior of the UI when a numerical answer is entered and returns the resulting formatted number
GET /v1/quiz_submissions/{quiz_submission_id}/questions/{id}/formatted_answer - Write
Answering questions
Provide or update an answer to one or more QuizQuestions.
POST /v1/quiz_submissions/{quiz_submission_id}/questions - Destructive
Flagging a question.
Set a flag on a quiz question to indicate that you want to return to it later.
PUT /v1/quiz_submissions/{quiz_submission_id}/questions/{id}/flag - Destructive
Unflagging a question.
Remove the flag that you previously set on a quiz question after you've returned to it.
PUT /v1/quiz_submissions/{quiz_submission_id}/questions/{id}/unflag
Quiz Submission User List
- Write
Send a message to unsubmitted or submitted users for the quiz
{ "body": { "type": "string", "description": "message body of the conversation to be created", "example": "Please take the quiz." }, "recipients": { "type": "string", "description": "Who to send the message to. May be either 'submitted' or 'unsubmitted'", "example": "submitted" }, "subject": { "type": "string", "description": "Subject of the new Conversation created", "example": "ATTN: Quiz 101 Students" } }
POST /v1/courses/{course_id}/quizzes/{id}/submission_users/message
Quiz Submissions
- Read
Get all quiz submissions.
Get a list of all submissions for this quiz. Users who can view or manage grades for a course will have submissions from multiple users returned. A user who can only submit will have only their own submissions returned. When a user has an in-progress submission, only that submission is returned. When there isn't an in-progress quizsubmission, all completed submissions, including previous attempts, are returned. 200 OK response code is returned if the request was successful.
GET /v1/courses/{course_id}/quizzes/{quiz_id}/submissions - Read
Get the quiz submission.
Get the submission for this quiz for the current user. 200 OK response code is returned if the request was successful.
GET /v1/courses/{course_id}/quizzes/{quiz_id}/submission - Read
Get a single quiz submission.
Get a single quiz submission. 200 OK response code is returned if the request was successful.
GET /v1/courses/{course_id}/quizzes/{quiz_id}/submissions/{id} - Read
Get current quiz submission times.
Get the current timing data for the quiz attempt, both the endat timestamp and the timeleft parameter. Responses 200 OK if the request was successful
GET /v1/courses/{course_id}/quizzes/{quiz_id}/submissions/{id}/time - Write
Create the quiz submission (start a quiz-taking session)
Start taking a Quiz by creating a QuizSubmission which you can use to answer questions and submit your answers. Responses 200 OK if the request was successful 400 Bad Request if the quiz is locked 403 Forbidden if an invalid access code is specified 403 Forbidden if the Quiz's IP filter restriction does not pass 409 Conflict if a QuizSubmission already exists for this user and quiz
POST /v1/courses/{course_id}/quizzes/{quiz_id}/submissions - Write
Complete the quiz submission (turn it in).
Complete the quiz submission by marking it as complete and grading it. When the quiz submission has been marked as complete, no further modifications will be allowed. Responses 200 OK if the request was successful 403 Forbidden if an invalid access code is specified 403 Forbidden if the Quiz's IP filter restriction does not pass 403 Forbidden if an invalid token is specified 400 Bad Request if the QS is already complete 400 Bad Request if the attempt parameter is missing 400 Bad Request if the attempt parameter is not the latest attempt
POST /v1/courses/{course_id}/quizzes/{quiz_id}/submissions/{id}/complete - Destructive
Update student question scores and comments.
Update the amount of points a student has scored for questions they've answered, provide comments for the student about their answer(s), or simply fudge the total score by a specific amount of points. Responses 200 OK if the request was successful 403 Forbidden if you are not a teacher in this course 400 Bad Request if the attempt parameter is missing or invalid 400 Bad Request if the specified QS attempt is not yet complete
PUT /v1/courses/{course_id}/quizzes/{quiz_id}/submissions/{id}
Quizzes
- Read
List quizzes in a course
Returns the paginated list of Quizzes in this course.
GET /v1/courses/{course_id}/quizzes - Read
Get a single quiz
Returns the quiz with the given id.
GET /v1/courses/{course_id}/quizzes/{id} - Read
Validate quiz access code
Accepts an access code and returns a boolean indicating whether that access code is correct
POST /v1/courses/{course_id}/quizzes/{id}/validate_access_code - Write
Create a quiz
Create a new quiz for this course.
POST /v1/courses/{course_id}/quizzes - Write
Reorder quiz items
Change order of the quiz questions or groups within the quiz 204 No Content response code is returned if the reorder was successful.
POST /v1/courses/{course_id}/quizzes/{id}/reorder - Destructive
Edit a quiz
Modify an existing quiz. See the documentation for quiz creation. Additional arguments:
PUT /v1/courses/{course_id}/quizzes/{id} - Destructive
Delete a quiz
Deletes a quiz and returns the deleted quiz object.
DELETE /v1/courses/{course_id}/quizzes/{id}
Result
- Read
Show a collection of Results
Show existing Results of a line item. Can be used to retrieve a specific student's result by adding the userid (defined as the ltiuserid or the Canvas userid) as a query parameter (i.e. userid=1000). If userid is included, it will return only one Result in the collection if the result exists, otherwise it will be empty. May also limit number of results by adding the limit query param (i.e. limit=100)
GET /lti/courses/{course_id}/line_items/{line_item_id}/results - Read
Show a Result
Show existing Result of a line item.
GET /lti/courses/{course_id}/line_items/{line_item_id}/results/{id}
Roles
- Read
List roles
A paginated list of the roles available to an account.
GET /v1/accounts/{account_id}/roles - Read
Get a single role
Retrieve information about a single role
GET /v1/accounts/{account_id}/roles/{id} - Read
List assignable permissions
List all permissions that can be granted to roles in the given account. This returns largely the same information documented on the {file:file.permissions.html Permissions list page}, with a few caveats: Permission labels and group labels returned by this API are localized (the same text visible in the web UI). This API includes permissions added by plugins. This API excludes permissions that are disabled in or otherwise do not apply to the given account.
GET /v1/accounts/{account_id}/roles/permissions - Read
Get help text for permissions
these actions access only static (but localized) information about permissions, but require a logged-in user to mitigate possible abuse Retrieve information about what Canvas permissions do and considerations for their use.
GET /v1/permissions/{context_type}/{permission}/help - Read
Retrieve permission groups
Retrieve information about groups of granular permissions The return value is a dictionary of permission group keys to objects containing +label+ and +subtitle+ keys.
GET /v1/permissions/groups - Write
Create a new role
Create a new course-level or account-level role.
POST /v1/accounts/{account_id}/roles - Write
Activate a role
Re-activates an inactive role (allowing it to be assigned to new users)
POST /v1/accounts/{account_id}/roles/{id}/activate - Destructive
Deactivate a role
Deactivates a custom role. This hides it in the user interface and prevents it from being assigned to new users. Existing users assigned to the role will continue to function with the same permissions they had previously. Built-in roles cannot be deactivated.
DELETE /v1/accounts/{account_id}/roles/{id} - Destructive
Update a role
Update permissions for an existing role. Recognized roles are: TeacherEnrollment StudentEnrollment TaEnrollment ObserverEnrollment DesignerEnrollment AccountAdmin Any previously created custom role
PUT /v1/accounts/{account_id}/roles/{id}
Rubrics
- Read
List rubrics
Returns the paginated list of active rubrics for the current context.
GET /v1/accounts/{account_id}/rubrics - Read
List rubrics
Returns the paginated list of active rubrics for the current context.
GET /v1/courses/{course_id}/rubrics - Read
Get a single rubric
Returns the rubric with the given id.
GET /v1/accounts/{account_id}/rubrics/{id} - Read
Get a single rubric
Returns the rubric with the given id.
GET /v1/courses/{course_id}/rubrics/{id} - Read
Get the courses and assignments for a rubric
Returns the courses and assignments where a rubric is being used
GET /v1/courses/{course_id}/rubrics/{id}/used_locations - Read
Get the courses and assignments for a rubric
Returns the courses and assignments where a rubric is being used
GET /v1/accounts/{account_id}/rubrics/{id}/used_locations - Read
Templated file for importing a rubric
Returns a CSV template file that can be used to import rubrics into Canvas.
GET /v1/rubrics/upload_template - Read
Get the status of a rubric import
Can return the latest rubric import for an account or course, or a specific import by id
GET /v1/courses/{course_id}/rubrics/upload/{id} - Read
Get the status of a rubric import
Can return the latest rubric import for an account or course, or a specific import by id
GET /v1/accounts/{account_id}/rubrics/upload/{id} - Write
Create a single rubric
Returns the rubric with the given id. Unfortunately this endpoint does not return a standard Rubric object, instead it returns a hash that looks like { 'rubric': Rubric, 'rubricassociation': RubricAssociation } This may eventually be deprecated in favor of a more standardized return value, but that is not currently planned. Any +rubric[...]+ field you leave out is left unchanged. +rubric[criteria]+, when present, replaces the entire set of criteria rather than merging into it, so send an empty +rubric[criteria]+ to clear them all.
POST /v1/courses/{course_id}/rubrics - Write
Creates a rubric using a CSV file
Returns the rubric import object that was created
POST /v1/courses/{course_id}/rubrics/upload - Write
Creates a rubric using a CSV file
Returns the rubric import object that was created
POST /v1/accounts/{account_id}/rubrics/upload - Write
Create a single rubric assessment
Returns the rubric assessment with the given id. The returned object also provides the information of :ratings, :assessorname, :relatedgroupsubmissionsandassessments, :artifact
POST /v1/courses/{course_id}/rubric_associations/{rubric_association_id}/rubric_assessments - Write
Create a RubricAssociation
Returns the rubric with the given id.
POST /v1/courses/{course_id}/rubric_associations - Destructive
Update a single rubric
Returns the rubric with the given id. Unfortunately this endpoint does not return a standard Rubric object, instead it returns a hash that looks like { 'rubric': Rubric, 'rubricassociation': RubricAssociation } This may eventually be deprecated in favor of a more standardized return value, but that is not currently planned. Any +rubric[...]+ field you leave out is left unchanged, so updating the title alone will not disturb the criteria. +rubric[criteria]+, when present, replaces the entire set of criteria rather than merging into it, so send an empty +rubric[criteria]+ to clear them all.
PUT /v1/courses/{course_id}/rubrics/{id} - Destructive
Delete a single
Deletes a Rubric and removes all RubricAssociations.
DELETE /v1/courses/{course_id}/rubrics/{id} - Destructive
Update a single rubric assessment
Returns the rubric assessment with the given id. The returned object also provides the information of :ratings, :assessorname, :relatedgroupsubmissionsandassessments, :artifact
PUT /v1/courses/{course_id}/rubric_associations/{rubric_association_id}/rubric_assessments/{id} - Destructive
Delete a single rubric assessment
Deletes a rubric assessment
DELETE /v1/courses/{course_id}/rubric_associations/{rubric_association_id}/rubric_assessments/{id} - Destructive
Update a RubricAssociation
Returns the rubric with the given id.
PUT /v1/courses/{course_id}/rubric_associations/{id} - Destructive
Delete a RubricAssociation
Delete the RubricAssociation with the given ID
DELETE /v1/courses/{course_id}/rubric_associations/{id}
Sandboxes
- Read
Download UUID Mapping for this Sandbox
This endpoint returns a CSV file with the UUID mapping for the sandbox. The CSV has three columns: type - The object type originaluuid - The UUID of an object from the template newuuid - The UUID of the corresponding object in the sandbox
GET /lti/uuid_map
Score
- Write
Create a Score
Create a new Result from the score params. If this is for the first created lineitem for a resourceLinkId, or it is a line item that is not attached to a resourceLinkId, then a submission record will be created for the associated assignment when gradingProgress is set to FullyGraded or PendingManual. The submission score will also be updated when a score object is sent with either of those two values for gradingProgress. If a score object is sent with either of FullyGraded or PendingManual as the value for gradingProgress and scoreGiven is missing, the assignment will not be graded. This also supposes the lineitem meets the condition to create a submission. A submission comment with an unknown author will be created when the comment value is included. This also supposes the lineitem meets the condition to create a submission. It is also possible to submit a file along with this score, which will attach the file to the submission that is created. Files should be formatted as Content Items, with the correct syntax below. Returns a url pointing to the Result. If any files were submitted, also returns the Content Items which were sent in the request, each with a url pointing to the Progress of the file upload.
POST /lti/courses/{course_id}/line_items/{line_item_id}/scores
Search
- Read
Find recipients
Find valid recipients (users, courses and groups) that the current user can send messages to. The /api/v1/search/recipients path is the preferred endpoint, /api/v1/conversations/findrecipients is deprecated. Pagination is supported.
GET /v1/conversations/find_recipients - Read
Find recipients
Find valid recipients (users, courses and groups) that the current user can send messages to. The /api/v1/search/recipients path is the preferred endpoint, /api/v1/conversations/findrecipients is deprecated. Pagination is supported.
GET /v1/search/recipients - Read
List all courses
A paginated list of all courses visible in the public index
GET /v1/search/all_courses
Sections
- Read
List course sections
A paginated list of the list of sections for this course.
GET /v1/courses/{course_id}/sections - Read
Get section information
Gets details about a specific section
GET /v1/courses/{course_id}/sections/{id} - Read
Get section information
Gets details about a specific section
GET /v1/sections/{id} - Read
List section's users
Returns a paginated list of users in the section.
GET /v1/sections/{id}/users - Write
Create course section
Creates a new section for this course.
POST /v1/courses/{course_id}/sections - Write
Cross-list a Section
Move the Section to another course. The new course may be in a different account (department), but must belong to the same root account (institution).
POST /v1/sections/{id}/crosslist/{new_course_id} - Destructive
De-cross-list a Section
Undo cross-listing of a Section, returning it to its original course.
DELETE /v1/sections/{id}/crosslist - Destructive
Edit a section
Modify an existing section.
PUT /v1/sections/{id} - Destructive
Delete a section
Delete an existing section. Returns the former Section.
DELETE /v1/sections/{id}
Services
- Read
Get Kaltura config
Return the config information for the Kaltura plugin in json format.
GET /v1/services/kaltura - Write
Start Kaltura session
Start a new Kaltura session, so that new media can be recorded and uploaded to this Canvas instance's Kaltura instance.
POST /v1/services/kaltura_session
Shared Brand Configs
SIS Import Errors
- Read
Get SIS import error list
Returns the list of SIS import errors for an account or a SIS import. Import errors are only stored for 30 days. Example: curl 'https:// /api/v1/accounts/ /sisimports/ /sisimporterrors' \ -H "Authorization: Bearer " Example: curl 'https:// /api/v1/accounts/ /sisimporterrors' \ -H "Authorization: Bearer "
GET /v1/accounts/{account_id}/sis_imports/{id}/errors - Read
Get SIS import error list
Returns the list of SIS import errors for an account or a SIS import. Import errors are only stored for 30 days. Example: curl 'https:// /api/v1/accounts/ /sisimports/ /sisimporterrors' \ -H "Authorization: Bearer " Example: curl 'https:// /api/v1/accounts/ /sisimporterrors' \ -H "Authorization: Bearer "
GET /v1/accounts/{account_id}/sis_import_errors
SIS Imports
- Read
Get SIS import list
Returns the list of SIS imports for an account Example: curl https:// /api/v1/accounts/ /sisimports \ -H 'Authorization: Bearer '
GET /v1/accounts/{account_id}/sis_imports - Read
Get the current importing SIS import
Returns the SIS imports that are currently processing for an account. If no imports are running, will return an empty array. Example: curl https:// /api/v1/accounts/ /sisimports/importing \ -H 'Authorization: Bearer '
GET /v1/accounts/{account_id}/sis_imports/importing - Read
Get SIS import status
Get the status of an already created SIS import. Examples: curl https:// /api/v1/accounts/ /sisimports/ \ -H 'Authorization: Bearer '
GET /v1/accounts/{account_id}/sis_imports/{id} - Destructive
Import SIS data
Import SIS data into Canvas. Must be on a root account with SIS imports enabled. For more information on the format that's expected here, please see the "SIS CSV" section in the API docs.
POST /v1/accounts/{account_id}/sis_imports - Destructive
Restore workflowstates of SIS imported items
This will restore the the workflowstate for all the items that changed their workflowstate during the import being restored. This will restore states for items imported with the following importers: accounts.csv terms.csv courses.csv sections.csv groupcategories.csv groups.csv users.csv admins.csv This also restores states for other items that changed during the import. An example would be if an enrollment was deleted from a sis import and the groupmembership was also deleted as a result of the enrollment deletion, both items would be restored when the sis batch is restored. Restore data is retained for 30 days post-import. This endpoint is unavailable after that time.
PUT /v1/accounts/{account_id}/sis_imports/{id}/restore_states - Destructive
Abort SIS import
Abort a SIS import that has not completed. Aborting a sis batch that is running can take some time for every process to see the abort event. Subsequent sis batches begin to process 10 minutes after the abort to allow each process to clean up properly.
PUT /v1/accounts/{account_id}/sis_imports/{id}/abort - Destructive
Abort all pending SIS imports
Abort already created but not processed or processing SIS imports.
PUT /v1/accounts/{account_id}/sis_imports/abort_all_pending
SIS Integration
- Read
Retrieve assignments enabled for grade export to SIS
Retrieve a list of published assignments flagged as "posttosis". See the Assignments API for more details on assignments. Assignment group and section information are included for convenience. Each section includes course information for the origin course and the cross-listed course, if applicable. The origincourse is the course to which the section belongs or the course from which the section was cross-listed. Generally, the origincourse should be preferred when performing integration work. The xlistcourse is provided for consistency and is only present when the section has been cross-listed. See Sections API and Courses Api for me details. The override is only provided if the Differentiated Assignments course feature is turned on and the assignment has an override for that section. When there is an override for the assignment the override object's keys/values can be merged with the top level assignment object to create a view of the assignment object specific to that section. See Assignments api for more information on assignment overrides. restricts to courses that start before this date (if they have a start date) restricts to courses that end after this date (if they have an end date) information to include. "studentoverrides":: returns individual student override information
GET /sis/accounts/{account_id}/assignments - Read
Retrieve assignments enabled for grade export to SIS
Retrieve a list of published assignments flagged as "posttosis". See the Assignments API for more details on assignments. Assignment group and section information are included for convenience. Each section includes course information for the origin course and the cross-listed course, if applicable. The origincourse is the course to which the section belongs or the course from which the section was cross-listed. Generally, the origincourse should be preferred when performing integration work. The xlistcourse is provided for consistency and is only present when the section has been cross-listed. See Sections API and Courses Api for me details. The override is only provided if the Differentiated Assignments course feature is turned on and the assignment has an override for that section. When there is an override for the assignment the override object's keys/values can be merged with the top level assignment object to create a view of the assignment object specific to that section. See Assignments api for more information on assignment overrides. restricts to courses that start before this date (if they have a start date) restricts to courses that end after this date (if they have an end date) information to include. "studentoverrides":: returns individual student override information
GET /sis/courses/{course_id}/assignments - Destructive
Disable assignments currently enabled for grade export to SIS
Disable all assignments flagged as "posttosis", with the option of making it specific to a grading period, in a course. On success, the response will be 204 No Content with an empty body. On failure, the response will be 400 Bad Request with a body of a specific message. For disabling assignments in a specific grading period
PUT /sis/courses/{course_id}/disable_post_to_sis
Smart Search
- Read
Search course content
Find course content using a meaning-based search
GET /v1/courses/{course_id}/smartsearch
Study Assist
- Write
Request a study assist response
Request a study assist response
POST /v1/courses/{course_id}/study_assist
Submission Comments
- Write
Upload a file
Upload a file to attach to a submission comment See the {file:file.fileuploads.html File Upload Documentation} for details on the file upload workflow. The final step of the file upload workflow will return the attachment data, including the new file id. The caller can then PUT the fileid to the submission API to attach it to a comment
POST /v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/comments/files - Write
Send annotation notification
Send notification of annotation to other users of the submission Must have permission to sendmessages on Site Admin account. annotation notifications go to all users on the submission and the observers for those users. annotation notifications also go to the instructors unless it is sent from an instructor. annotation notifications from instructors go to students if assignment is set to post automatically or if the assignment is posted. returns {}, status 200
POST /v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/annotation_notification - Destructive
Edit a submission comment
Edit the given submission comment.
PUT /v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/comments/{id} - Destructive
Delete a submission comment
Delete the given submission comment.
DELETE /v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/comments/{id}
Submissions
- Read
List assignment submissions
A paginated list of all existing submissions for an assignment.
GET /v1/courses/{course_id}/assignments/{assignment_id}/submissions - Read
List assignment submissions
A paginated list of all existing submissions for an assignment.
GET /v1/sections/{section_id}/assignments/{assignment_id}/submissions - Read
List submissions for multiple assignments
A paginated list of all existing submissions for a given set of students and assignments.
GET /v1/courses/{course_id}/students/submissions - Read
List submissions for multiple assignments
A paginated list of all existing submissions for a given set of students and assignments.
GET /v1/sections/{section_id}/students/submissions - Read
Get a single submission
Get a single submission, based on user id.
GET /v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id} - Read
Get a single submission
Get a single submission, based on user id.
GET /v1/sections/{section_id}/assignments/{assignment_id}/submissions/{user_id} - Read
Get a single submission by anonymous id
Get a single submission, based on the submission's anonymous id.
GET /v1/courses/{course_id}/assignments/{assignment_id}/anonymous_submissions/{anonymous_id} - Read
Get a single submission by anonymous id
Get a single submission, based on the submission's anonymous id.
GET /v1/sections/{section_id}/assignments/{assignment_id}/anonymous_submissions/{anonymous_id} - Read
List gradeable students
A paginated list of gradeable students for the assignment. The caller must have permission to view grades. If anonymous grading is enabled for the current assignment and the allownewanonymousid parameter is passed, the returned data will not include any values identifying the student, but will instead include an assignment-specific anonymous ID for each student. Section-limited instructors will only see students in their own sections.
GET /v1/courses/{course_id}/assignments/{assignment_id}/gradeable_students - Read
List multiple assignments gradeable students
A paginated list of students eligible to submit a list of assignments. The caller must have permission to view grades for the requested course. Section-limited instructors will only see students in their own sections.
GET /v1/courses/{course_id}/assignments/gradeable_students - Read
Get rubric assessments read state
Return whether new rubric comments/grading made on a submission have been seen by the student being assessed.
GET /v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/rubric_comments/read - Read
Get rubric assessments read state
Return whether new rubric comments/grading made on a submission have been seen by the student being assessed.
GET /v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/rubric_assessments/read - Read
Get rubric assessments read state
Return whether new rubric comments/grading made on a submission have been seen by the student being assessed.
GET /v1/sections/{section_id}/assignments/{assignment_id}/submissions/{user_id}/rubric_comments/read - Read
Get rubric assessments read state
Return whether new rubric comments/grading made on a submission have been seen by the student being assessed.
GET /v1/sections/{section_id}/assignments/{assignment_id}/submissions/{user_id}/rubric_assessments/read - Read
Get document annotations read state
Return whether annotations made on a submitted document have been read by the student
GET /v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/document_annotations/read - Read
Get document annotations read state
Return whether annotations made on a submitted document have been read by the student
GET /v1/sections/{section_id}/assignments/{assignment_id}/submissions/{user_id}/document_annotations/read - Read
Submission Summary
Returns the number of submissions for the given assignment based on gradeable students that fall into three categories: graded, ungraded, not submitted.
GET /v1/courses/{course_id}/assignments/{assignment_id}/submission_summary - Read
Submission Summary
Returns the number of submissions for the given assignment based on gradeable students that fall into three categories: graded, ungraded, not submitted.
GET /v1/sections/{section_id}/assignments/{assignment_id}/submission_summary - Write
Submit an assignment
Make a submission for an assignment. You must be actively enrolled as a student in the course/section to do this. Concluded and pending enrollments are not permitted. All online turn-in submission types are supported in this API. However, there are a few things that are not yet supported: Files can be submitted based on a file ID of a user or group file or through the {api:SubmissionsApiControllercreatefile file upload API}. However, there is no API yet for listing the user and group files. Media comments can be submitted, however, there is no API yet for creating a media comment to submit. Integration with Google Docs is not yet supported.
POST /v1/courses/{course_id}/assignments/{assignment_id}/submissions - Write
Submit an assignment
Make a submission for an assignment. You must be actively enrolled as a student in the course/section to do this. Concluded and pending enrollments are not permitted. All online turn-in submission types are supported in this API. However, there are a few things that are not yet supported: Files can be submitted based on a file ID of a user or group file or through the {api:SubmissionsApiControllercreatefile file upload API}. However, there is no API yet for listing the user and group files. Media comments can be submitted, however, there is no API yet for creating a media comment to submit. Integration with Google Docs is not yet supported.
POST /v1/sections/{section_id}/assignments/{assignment_id}/submissions - Write
Upload a file
Upload a file to a submission. This API endpoint is the first step in uploading a file to a submission as a student. See the {file:file.fileuploads.html File Upload Documentation} for details on the file upload workflow. The final step of the file upload workflow will return the attachment data, including the new file id. The caller can then POST to submit the +onlineupload+ assignment with these file ids.
POST /v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/files - Write
Upload a file
Upload a file to a submission. This API endpoint is the first step in uploading a file to a submission as a student. See the {file:file.fileuploads.html File Upload Documentation} for details on the file upload workflow. The final step of the file upload workflow will return the attachment data, including the new file id. The caller can then POST to submit the +onlineupload+ assignment with these file ids.
POST /v1/sections/{section_id}/assignments/{assignment_id}/submissions/{user_id}/files - Write
Grade or comment on multiple submissions
Update the grading and comments on multiple student's assignment submissions in an asynchronous job. The user must have permission to manage grades in the appropriate context (course or section).
POST /v1/courses/{course_id}/submissions/update_grades - Write
Grade or comment on multiple submissions
Update the grading and comments on multiple student's assignment submissions in an asynchronous job. The user must have permission to manage grades in the appropriate context (course or section).
POST /v1/courses/{course_id}/assignments/{assignment_id}/submissions/update_grades - Write
Grade or comment on multiple submissions
Update the grading and comments on multiple student's assignment submissions in an asynchronous job. The user must have permission to manage grades in the appropriate context (course or section).
POST /v1/sections/{section_id}/submissions/update_grades - Write
Grade or comment on multiple submissions
Update the grading and comments on multiple student's assignment submissions in an asynchronous job. The user must have permission to manage grades in the appropriate context (course or section).
POST /v1/sections/{section_id}/assignments/{assignment_id}/submissions/update_grades - Destructive
Grade or comment on a submission
Comment on and/or update the grading for a student's assignment submission. If any submission or rubricassessment arguments are provided, the user must have permission to manage grades in the appropriate context (course or section).
PUT /v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id} - Destructive
Grade or comment on a submission
Comment on and/or update the grading for a student's assignment submission. If any submission or rubricassessment arguments are provided, the user must have permission to manage grades in the appropriate context (course or section).
PUT /v1/sections/{section_id}/assignments/{assignment_id}/submissions/{user_id} - Destructive
Grade or comment on a submission by anonymous id
Comment on and/or update the grading for a student's assignment submission, fetching the submission by anonymous id (instead of user id). If any submission or rubricassessment arguments are provided, the user must have permission to manage grades in the appropriate context (course or section).
PUT /v1/courses/{course_id}/assignments/{assignment_id}/anonymous_submissions/{anonymous_id} - Destructive
Grade or comment on a submission by anonymous id
Comment on and/or update the grading for a student's assignment submission, fetching the submission by anonymous id (instead of user id). If any submission or rubricassessment arguments are provided, the user must have permission to manage grades in the appropriate context (course or section).
PUT /v1/sections/{section_id}/assignments/{assignment_id}/anonymous_submissions/{anonymous_id} - Destructive
Mark submission as read
No request fields are necessary. On success, the response will be 204 No Content with an empty body.
PUT /v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/read - Destructive
Mark submission as read
No request fields are necessary. On success, the response will be 204 No Content with an empty body.
PUT /v1/sections/{section_id}/assignments/{assignment_id}/submissions/{user_id}/read - Destructive
Mark submission as unread
No request fields are necessary. On success, the response will be 204 No Content with an empty body.
DELETE /v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/read - Destructive
Mark submission as unread
No request fields are necessary. On success, the response will be 204 No Content with an empty body.
DELETE /v1/sections/{section_id}/assignments/{assignment_id}/submissions/{user_id}/read - Destructive
Mark bulk submissions as read
Accepts a string array of submission ids. Loops through and marks each submission as read On success, the response will be 204 No Content with an empty body.
PUT /v1/courses/{course_id}/submissions/bulk_mark_read - Destructive
Mark bulk submissions as read
Accepts a string array of submission ids. Loops through and marks each submission as read On success, the response will be 204 No Content with an empty body.
PUT /v1/sections/{section_id}/submissions/bulk_mark_read - Destructive
Mark submission item as read
No request fields are necessary. A submission item can be "grade", "comment" or "rubric" On success, the response will be 204 No Content with an empty body.
PUT /v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/read/{item} - Destructive
Mark submission item as read
No request fields are necessary. A submission item can be "grade", "comment" or "rubric" On success, the response will be 204 No Content with an empty body.
PUT /v1/sections/{section_id}/assignments/{assignment_id}/submissions/{user_id}/read/{item} - Destructive
Clear unread status for all submissions.
Site-admin-only endpoint. No request fields are necessary. On success, the response will be 204 No Content with an empty body.
PUT /v1/courses/{course_id}/submissions/{user_id}/clear_unread - Destructive
Clear unread status for all submissions.
Site-admin-only endpoint. No request fields are necessary. On success, the response will be 204 No Content with an empty body.
PUT /v1/sections/{section_id}/submissions/{user_id}/clear_unread - Destructive
Mark rubric assessments as read
Indicate that rubric comments/grading made on a submission have been read by the student being assessed. Only the student who owns the submission can use this endpoint. NOTE: Rubric assessments will be marked as read automatically when they are viewed in Canvas web.
PUT /v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/rubric_comments/read - Destructive
Mark rubric assessments as read
Indicate that rubric comments/grading made on a submission have been read by the student being assessed. Only the student who owns the submission can use this endpoint. NOTE: Rubric assessments will be marked as read automatically when they are viewed in Canvas web.
PUT /v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/rubric_assessments/read - Destructive
Mark rubric assessments as read
Indicate that rubric comments/grading made on a submission have been read by the student being assessed. Only the student who owns the submission can use this endpoint. NOTE: Rubric assessments will be marked as read automatically when they are viewed in Canvas web.
PUT /v1/sections/{section_id}/assignments/{assignment_id}/submissions/{user_id}/rubric_comments/read - Destructive
Mark rubric assessments as read
Indicate that rubric comments/grading made on a submission have been read by the student being assessed. Only the student who owns the submission can use this endpoint. NOTE: Rubric assessments will be marked as read automatically when they are viewed in Canvas web.
PUT /v1/sections/{section_id}/assignments/{assignment_id}/submissions/{user_id}/rubric_assessments/read - Destructive
Mark document annotations as read
Indicate that annotations made on a submitted document have been read by the student. Only the student who owns the submission can use this endpoint. NOTE: Document annotations will be marked as read automatically when they are viewed in Canvas web.
PUT /v1/courses/{course_id}/assignments/{assignment_id}/submissions/{user_id}/document_annotations/read - Destructive
Mark document annotations as read
Indicate that annotations made on a submitted document have been read by the student. Only the student who owns the submission can use this endpoint. NOTE: Document annotations will be marked as read automatically when they are viewed in Canvas web.
PUT /v1/sections/{section_id}/assignments/{assignment_id}/submissions/{user_id}/document_annotations/read
Tabs
- Read
List available tabs for a course or group
Returns a list of navigation tabs available in the current context.
GET /v1/accounts/{account_id}/tabs - Read
List available tabs for a course or group
Returns a list of navigation tabs available in the current context.
GET /v1/courses/{course_id}/tabs - Read
List available tabs for a course or group
Returns a list of navigation tabs available in the current context.
GET /v1/groups/{group_id}/tabs - Read
List available tabs for a course or group
Returns a list of navigation tabs available in the current context.
GET /v1/users/{user_id}/tabs - Destructive
Update a tab for a course
Home and Settings tabs are not manageable, and can't be hidden or moved Returns a tab object
PUT /v1/courses/{course_id}/tabs/{tab_id}
Temporary Enrollment Pairings
- Read
List temporary enrollment pairings
Returns the list of temporary enrollment pairings for a root account, ordered by creation time. This endpoint is paginated. Use the +perpage+ parameter to control the page size, and follow the URLs in the Link response header (current, next, prev, first) to navigate between pages. See the Pagination documentation for details.
GET /v1/accounts/{account_id}/temporary_enrollment_pairings - Read
Get a single temporary enrollment pairing
Returns the temporary enrollment pairing with the given id.
GET /v1/accounts/{account_id}/temporary_enrollment_pairings/{id} - Read
New TemporaryEnrollmentPairing
Initialize an unsaved Temporary Enrollment Pairing.
GET /v1/accounts/{account_id}/temporary_enrollment_pairings/new - Destructive
Create Temporary Enrollment Pairing
Create a Temporary Enrollment Pairing.
POST /v1/accounts/{account_id}/temporary_enrollment_pairings - Destructive
Delete Temporary Enrollment Pairing
Delete a temporary enrollment pairing
DELETE /v1/accounts/{account_id}/temporary_enrollment_pairings/{id}
User Observees
- Read
List linked observees
A paginated list of users that the given user is observing. This endpoint returns users linked to the observer at the account level (such that the observer is automatically enrolled in observees' courses); it doesn't return one-off observer enrollments from individual courses. Note: all users are allowed to list their own observees. Administrators can list other users' observees. The returned observees will include an attribute "observationlinkrootaccountids", a list of ids for the root accounts the observer and observee are linked on. The observer will only be able to observe in courses associated with these root accounts.
GET /v1/users/{user_id}/observees - Read
List linked observers
A paginated list of observers linked to a given user. Note: all users are allowed to list their own observers. Administrators can list other users' observers. The returned observers will include an attribute "observationlinkrootaccountids", a list of ids for the root accounts the observer and observee are linked on. The observer will only be able to observe in courses associated with these root accounts.
GET /v1/users/{user_id}/observers - Read
Show an observee
Gets information about an observed user. Note: all users are allowed to view their own observees.
GET /v1/users/{user_id}/observees/{observee_id} - Read
Show an observer
Gets information about an observer. Note: all users are allowed to view their own observers.
GET /v1/users/{user_id}/observers/{observer_id} - Write
Add an observee with credentials
Register the given user to observe another user, given the observee's credentials. Note: all users are allowed to add their own observees, given the observee's credentials or access token are provided. Administrators can add observees given credentials, access token or the {api:UserObserveesControllerupdate observee's id}.
POST /v1/users/{user_id}/observees - Write
Create observer pairing code
If the user is a student, will generate a code to be used with self registration or observees APIs to link another user to this student.
POST /v1/users/{user_id}/observer_pairing_codes - Destructive
Add an observee
Registers a user as being observed by the given user.
PUT /v1/users/{user_id}/observees/{observee_id} - Destructive
Remove an observee
Unregisters a user as being observed by the given user.
DELETE /v1/users/{user_id}/observees/{observee_id}
Users
- Read
List users in account
A paginated list of users associated with this account. @examplerequest curl https:// /api/v1/accounts/self/users?searchterm= \ -X GET \ -H 'Authorization: Bearer '
GET /v1/accounts/{account_id}/users - Read
List the activity stream
Returns the current user's global activity stream, paginated. There are many types of objects that can be returned in the activity stream. All object types have the same basic set of shared attributes: !!!javascript { 'createdat': '2011-07-13T09:12:00Z', 'updatedat': '2011-07-25T08:52:41Z', 'id': 1234, 'title': 'Stream Item Subject', 'message': 'This is the body text of the activity stream item. It is plain-text, and can be multiple paragraphs.', 'type': 'DiscussionTopic|Conversation|Message|Submission|Conference|Collaboration|AssessmentRequest...', 'readstate': false, 'contexttype': 'course', // course|group 'courseid': 1, 'groupid': null, 'htmlurl': "http://..." // URL to the Canvas web UI for this stream item } In addition, each item type has its own set of attributes available. DiscussionTopic: !!!javascript { 'type': 'DiscussionTopic', 'discussiontopicid': 1234, 'totalrootdiscussionentries': 5, 'requireinitialpost': true, 'userhasposted': true, 'rootdiscussionentries': { ... } } For DiscussionTopic, the message is truncated at 4kb. Announcement: !!!javascript { 'type': 'Announcement', 'announcementid': 1234, 'totalrootdiscussionentries': 5, 'requireinitialpost': true, 'userhasposted': null, 'rootdiscussionentries': { ... } } For Announcement, the message is truncated at 4kb. Conversation: !!!javascript { 'type': 'Conversation', 'conversationid': 1234, 'private': false, 'participantcount': 3, } Message: !!!javascript { 'type': 'Message', 'messageid': 1234, 'notificationcategory': 'Assignment Graded' } Submission: Returns an {api:Submissions:Submission Submission} with its Course and Assignment data. Conference: !!!javascript { 'type': 'Conference', 'webconferenceid': 1234 } Collaboration: !!!javascript { 'type': 'Collaboration', 'collaborationid': 1234 } AssessmentRequest: !!!javascript { 'type': 'AssessmentRequest', 'assessmentrequestid': 1234 }
GET /v1/users/self/activity_stream - Read
List the activity stream
Returns the current user's global activity stream, paginated. There are many types of objects that can be returned in the activity stream. All object types have the same basic set of shared attributes: !!!javascript { 'createdat': '2011-07-13T09:12:00Z', 'updatedat': '2011-07-25T08:52:41Z', 'id': 1234, 'title': 'Stream Item Subject', 'message': 'This is the body text of the activity stream item. It is plain-text, and can be multiple paragraphs.', 'type': 'DiscussionTopic|Conversation|Message|Submission|Conference|Collaboration|AssessmentRequest...', 'readstate': false, 'contexttype': 'course', // course|group 'courseid': 1, 'groupid': null, 'htmlurl': "http://..." // URL to the Canvas web UI for this stream item } In addition, each item type has its own set of attributes available. DiscussionTopic: !!!javascript { 'type': 'DiscussionTopic', 'discussiontopicid': 1234, 'totalrootdiscussionentries': 5, 'requireinitialpost': true, 'userhasposted': true, 'rootdiscussionentries': { ... } } For DiscussionTopic, the message is truncated at 4kb. Announcement: !!!javascript { 'type': 'Announcement', 'announcementid': 1234, 'totalrootdiscussionentries': 5, 'requireinitialpost': true, 'userhasposted': null, 'rootdiscussionentries': { ... } } For Announcement, the message is truncated at 4kb. Conversation: !!!javascript { 'type': 'Conversation', 'conversationid': 1234, 'private': false, 'participantcount': 3, } Message: !!!javascript { 'type': 'Message', 'messageid': 1234, 'notificationcategory': 'Assignment Graded' } Submission: Returns an {api:Submissions:Submission Submission} with its Course and Assignment data. Conference: !!!javascript { 'type': 'Conference', 'webconferenceid': 1234 } Collaboration: !!!javascript { 'type': 'Collaboration', 'collaborationid': 1234 } AssessmentRequest: !!!javascript { 'type': 'AssessmentRequest', 'assessmentrequestid': 1234 }
GET /v1/users/activity_stream - Read
Activity stream summary
Returns a summary of the current user's global activity stream.
GET /v1/users/self/activity_stream/summary - Read
List the TODO items
A paginated list of the current user's list of todo items. There is a limit to the number of items returned. The ignore and ignorepermanently URLs can be used to update the user's preferences on what items will be displayed. Performing a DELETE request against the ignore URL will hide that item from future todo item requests, until the item changes. Performing a DELETE request against the ignorepermanently URL will hide that item forever.
GET /v1/users/self/todo - Read
List counts for todo items
Counts of different todo items such as the number of assignments needing grading as well as the number of assignments needing submitting. The three filters below narrow +needsgradingcount+ only. +assignmentsneedingsubmitting+ is not affected by any of them.
GET /v1/users/self/todo_item_count - Read
List upcoming assignments, calendar events
A paginated list of the current user's upcoming events.
GET /v1/users/self/upcoming_events - Read
List Missing Submissions
A paginated list of past-due assignments for which the student does not have a submission. The user sending the request must either be the student, an admin or a parent observer using the parent app
GET /v1/users/{user_id}/missing_submissions - Read
Show user details
Shows details for user. Also includes an attribute "permissions", a non-comprehensive list of permissions for the user. Example: !!!javascript "permissions": { "canupdatename": true, // Whether the user can update their name. "canupdateavatar": false, // Whether the user can update their avatar. "limitparentappwebaccess": false // Whether the user can interact with Canvas web from the Canvas Parent app. }
GET /v1/users/{id} - Read
Get custom colors
Returns all custom colors that have been saved for a user.
GET /v1/users/{id}/colors - Read
Get custom color
Returns the custom colors that have been saved for a user for a given context. The assetstring parameter should be in the format 'contextid', for example 'course42'.
GET /v1/users/{id}/colors/{asset_string} - Read
Get dashboard positions
Returns all dashboard positions that have been saved for a user.
GET /v1/users/{id}/dashboard_positions - Read
Get a users most recently graded submissions
Returns a list of the user's most recently graded submissions.
GET /v1/users/{id}/graded_submissions - Read
Get user profile
Returns user profile data, including user id, name, and profile pic. When requesting the profile for the user accessing the API, the user's calendar feed URL and LTI user id will be returned as well.
GET /v1/users/{user_id}/profile - Read
List avatar options
A paginated list of the possible user avatar options that can be set with the user update endpoint. The response will be an array of avatar records. If the 'type' field is 'attachment', the record will include all the normal attachment json fields; otherwise it will include only the 'url' and 'displayname' fields. Additionally, all records will include a 'type' field and a 'token' field. The following explains each field in more detail type:: ["gravatar"|"attachment"|"nopic"] The type of avatar record, for categorization purposes. url:: The url of the avatar token:: A unique representation of the avatar record which can be used to set the avatar with the user update endpoint. Note: this is an internal representation and is subject to change without notice. It should be consumed with this api endpoint and used in the user update endpoint, and should not be constructed by the client. displayname:: A textual description of the avatar record id:: ['attachment' type only] the internal id of the attachment content-type:: ['attachment' type only] the content-type of the attachment filename:: ['attachment' type only] the filename of the attachment size:: ['attachment' type only] the size of the attachment
GET /v1/users/{user_id}/avatars - Read
List user page views
Return a paginated list of the user's page view history in json format, similar to the available CSV download. Page views are returned in descending order, newest to oldest.
GET /v1/users/{user_id}/page_views - Read
BETA - Poll query status
Checks the status of a previously initiated page views query. Returns the current processing status and provides a result URL when the query is complete. The query may fail with status "failed" and errorcode "RESULTSIZELIMITEXCEEDED" if the result exceeds 500 MB. If this happens, narrow the date range or query smaller time intervals. As this is a beta endpoint, it is subject to change or removal at any time without the standard notice periods outlined in the API policy.
GET /v1/users/{user_id}/page_views/query/{query_id} - Read
BETA - Get query results
Retrieves the results of a completed page views query. Returns the data in the format specified when the query was initiated (CSV or JSON). The response may be compressed with gzip encoding. As this is a beta endpoint, it is subject to change or removal at any time without the standard notice periods outlined in the API policy. Note: PageView payloads use two types of identifiers: globalId and localId. Global identifier is equal to (shardId10000000000000)+localId. Please note our global identifiers might change if your Canvas instance goes through shard migration process, in this case your current shardId in the global identifier will change to a new shardId. Local identifiers do not change after shard migration and stay unique in the context of the Canvas account. The following fields in the PageView payload are global identifiers: linksuser, linkscontext, linksasset, linksrealuser, linksaccount, developerkeyid, assetuseraccessid.
GET /v1/users/{user_id}/page_views/query/{query_id}/results - Read
BETA - Poll batch query status
Checks the status of a previously initiated batch page views query. Returns the current processing status and provides a result URL when the query is complete. As this is a beta endpoint, it is subject to change or removal at any time without the standard notice periods outlined in the API policy.
GET /v1/users/page_views/query/{query_id} - Read
BETA - Get batch query results
Retrieves the results of a completed batch page views query. Returns the data in the format specified when the query was initiated (CSV or JSON). The response may be compressed with gzip encoding. As this is a beta endpoint, it is subject to change or removal at any time without the standard notice periods outlined in the API policy.
GET /v1/users/page_views/query/{query_id}/results - Read
Load custom data
Load custom user data. Arbitrary JSON data can be stored for a User. This API call retrieves that data for a (optional) given scope. See {api:UsersControllersetcustomdata Store Custom Data} for details and examples. On success, this endpoint returns an object containing the data that was requested. Responds with status code 400 if the namespace parameter, +ns+, is missing or invalid, or if the specified scope does not contain any data.
GET /v1/users/{user_id}/custom_data - Read
List course nicknames
Returns all course nicknames you have set.
GET /v1/users/self/course_nicknames - Read
Get course nickname
Returns the nickname for a specific course.
GET /v1/users/self/course_nicknames/{course_id} - Write
Upload a file
Upload a file to the user's personal files section. This API endpoint is the first step in uploading a file to a user's files. See the {file:file.fileuploads.html File Upload Documentation} for details on the file upload workflow. Note that typically users will only be able to upload files to their own files section. Passing a userid of +self+ is an easy shortcut to specify the current user.
POST /v1/users/{user_id}/files - Write
Create a user
Create and return a new user and pseudonym for an account. [DEPRECATED (for self-registration only)] If you don't have the "Modify login details for users" permission, but self-registration is enabled on the account, you can still use this endpoint to register new users. Certain fields will be required, and others will be ignored (see below).
POST /v1/accounts/{account_id}/users - Write
[DEPRECATED] Self register a user
Self register and return a new user and pseudonym for an account. If self-registration is enabled on the account, you can use this endpoint to self register new users.
POST /v1/accounts/{account_id}/self_registration - Write
Update user settings.
Update an existing user's settings.
GET /v1/users/{id}/settings - Write
Split merged users into separate users
Merged users cannot be fully restored to their previous state, but this will attempt to split as much as possible to the previous state. To split a merged user, the caller must have permissions to manage all of the users logins. If there are multiple users that have been merged into one user it will split each merge into a separate user. A split can only happen within 180 days of a user merge. A user merge deletes the previous user and may be permanently deleted. In this scenario we create a new user object and proceed to move as much as possible to the new user. The user object will not have preserved the name or settings from the previous user. Some items may have been deleted during a usermerge that cannot be restored, and/or the data has become stale because of other changes to the objects since the time of the usermerge. Split users details and caveats: The fromuser is the user that was deleted in the usermerge process. The destinationuser is the user that remains, that is being split. Avatars: When both users had avatars, both will be remain. When fromuser had an avatar and destinationuser did not have an avatar, the destinationuser's avatar will be deleted if it still matches what was there are the time of the merge. If the destinationuser's avatar was changed at anytime after the merge, it will remain on the destination user. If the fromuser had an avatar it will be there after split. Terms of Use: If fromuser had not accepted terms of use, they will be prompted again to accept terms of use after the split. If the destinationuser had not accepted terms of use, hey will be prompted again to accept terms of use after the split. If neither user had accepted the terms of use, but since the time of the merge had accepted, both will be prompted to accept terms of use. If both had accepted terms of use, this will remain. Communication Channels: All communication channels are restored to what they were prior to the merge. If a communication channel was added after the merge, it will remain on the destinationuser. Notification preferences remain with the communication channels. Enrollments: All enrollments from the time of the merge will be moved back to where they were. Enrollments created since the time of the merge that were created by sisimport will go to the user that owns that sisid used for the import. Other new enrollments will remain on the destinationuser. Everything that is tied to the destinationuser at the course level relating to an enrollment is moved to the fromuser. When both users are in the same course prior to merge this can cause some unexpected items to move. Submissions: Unlike other items tied to a course, submissions are explicitly recorded to avoid problems with grades. All submissions were moved are restored to the spot prior to merge. All submission that were created in a course that was moved in enrollments are moved over to the fromuser. Other notes: Access Tokens are moved back on split. Conversations are moved back on split. Favorites that existing at the time of merge are moved back on split. LTI ids are restored to how they were prior to merge.
POST /v1/users/{id}/split - Write
Get a Pandata Events jwt token and its expiration date
Returns a jwt auth and props token that can be used to send events to Pandata. NOTE: This is currently only available to the mobile developer keys.
POST /v1/users/self/pandata_events_token - Write
BETA - Initiate page views query
Initiates an asynchronous query for user page views data within a specified date range. This method enqueues a background job to process the page views query and returns a polling URL that can be used to check the query status and retrieve results when ready. As this is a beta endpoint, it is subject to change or removal at any time without the standard notice periods outlined in the API policy.
POST /v1/users/{user_id}/page_views/query - Write
BETA - Initiate batch page views query
Initiates an asynchronous query for page views data across multiple users. This method enqueues a background job to process the batch page views query and returns a polling URL that can be used to check the query status and retrieve results when ready. As this is a beta endpoint, it is subject to change or removal at any time without the standard notice periods outlined in the API policy.
POST /v1/users/page_views/query - Destructive
Hide a stream item
Hide the given stream item.
DELETE /v1/users/self/activity_stream/{id} - Destructive
Hide all stream items
Hide all stream items for the user
DELETE /v1/users/self/activity_stream - Destructive
Update custom color
Updates a custom color for a user for a given context. This allows colors for the calendar and elsewhere to be customized on a user basis. The asset string parameter should be in the format 'contextid', for example 'course42'
PUT /v1/users/{id}/colors/{asset_string} - Destructive
Update text editor preference
Updates a user's default choice for text editor. This allows the Choose an Editor propmts to preload the user's preference.
PUT /v1/users/{id}/text_editor_preference - Destructive
Update files UI version preference
Updates a user's default choice for files UI version. This allows the files UI to preload the user's preference.
PUT /v1/users/{id}/files_ui_version_preference - Destructive
Update dashboard positions
Updates the dashboard positions for a user for a given context. This allows positions for the dashboard cards and elsewhere to be customized on a per user basis. The asset string parameter should be in the format 'contextid', for example 'course42'
PUT /v1/users/{id}/dashboard_positions - Destructive
Edit a user
Modify an existing user. To modify a user's login, see the documentation for logins.
PUT /v1/users/{id} - Destructive
Terminate all user sessions
Terminates all sessions for a user. This includes all browser-based sessions and all access tokens, including manually generated ones. The user can immediately re-authenticate to access Canvas again if they have the current credentials. All integrations will need to be re-authorized.
DELETE /v1/users/{id}/sessions - Destructive
Log users out of all mobile apps
Permanently expires any active mobile sessions, forcing them to re-authorize. The route that takes a user id will expire mobile sessions for that user. The route that doesn't take a user id will expire mobile sessions for all users in the institution (except for account administrators if +skipadmins+ is given).
DELETE /v1/users/mobile_sessions - Destructive
Log users out of all mobile apps
Permanently expires any active mobile sessions, forcing them to re-authorize. The route that takes a user id will expire mobile sessions for that user. The route that doesn't take a user id will expire mobile sessions for all users in the institution (except for account administrators if +skipadmins+ is given).
DELETE /v1/users/{id}/mobile_sessions - Destructive
Merge user into another user
Merge a user into another user. To merge users, the caller must have permissions to manage both users. This should be considered irreversible. This will delete the user and move all the data into the destination user. User merge details and caveats: The fromuser is the user that was deleted in the usermerge process. The destinationuser is the user that remains, that is being split. Avatars: When both users have avatars, only the destinationusers avatar will remain. When one user has an avatar, it will end up on the destinationuser. Terms of Use: If either user has accepted terms of use, it will be be left as accepted. Communication Channels: All unique communication channels moved to the destinationuser. All notification preferences are moved to the destinationuser. Enrollments: All unique enrollments are moved to the destinationuser. When there is an enrollment that would end up making it so that a user would be observing themselves, the enrollment is not moved over. Everything that is tied to the fromuser at the course level relating to the enrollment is also moved to the destinationuser. Submissions: All submissions are moved to the destinationuser. If there are enrollments for both users in the same course, we prefer submissions that have grades then submissions that have work in them, and if there are no grades or no work, they are not moved. Other notes: Access Tokens are moved on merge. Conversations are moved on merge. Favorites are moved on merge. Courses will commonly use LTI tools. LTI tools reference the user with IDs that are stored on a user object. Merging users deletes one user and moves all records from the deleted user to the destinationuser. These IDs are kept for all enrollments, groupmembership, and accountusers for the fromuser at the time of the merge. When the destinationuser launches an LTI tool from a course that used to be the fromuser's, it doesn't appear as a new user to the tool provider. Instead it will send the stored ids. The destinationuser's LTI IDs remain as they were for the courses that they originally had. Future enrollments for the destinationuser will use the IDs that are on the destinationuser object. LTI IDs that are kept and tracked per context include lticontextid, ltiid and uuid. APIs that return the LTI ids will return the one for the context that it is called for, except for the user uuid. The user UUID will display the destinationusers uuid, and when getting the uuid from an api that is in a context that was recorded from a merge event, an additional attribute is added as pastuuid. When finding users by SIS ids in different accounts the destinationaccountid is required. The account can also be identified by passing the domain in destinationaccountid.
PUT /v1/users/{id}/merge_into/{destination_user_id} - Destructive
Merge user into another user
Merge a user into another user. To merge users, the caller must have permissions to manage both users. This should be considered irreversible. This will delete the user and move all the data into the destination user. User merge details and caveats: The fromuser is the user that was deleted in the usermerge process. The destinationuser is the user that remains, that is being split. Avatars: When both users have avatars, only the destinationusers avatar will remain. When one user has an avatar, it will end up on the destinationuser. Terms of Use: If either user has accepted terms of use, it will be be left as accepted. Communication Channels: All unique communication channels moved to the destinationuser. All notification preferences are moved to the destinationuser. Enrollments: All unique enrollments are moved to the destinationuser. When there is an enrollment that would end up making it so that a user would be observing themselves, the enrollment is not moved over. Everything that is tied to the fromuser at the course level relating to the enrollment is also moved to the destinationuser. Submissions: All submissions are moved to the destinationuser. If there are enrollments for both users in the same course, we prefer submissions that have grades then submissions that have work in them, and if there are no grades or no work, they are not moved. Other notes: Access Tokens are moved on merge. Conversations are moved on merge. Favorites are moved on merge. Courses will commonly use LTI tools. LTI tools reference the user with IDs that are stored on a user object. Merging users deletes one user and moves all records from the deleted user to the destinationuser. These IDs are kept for all enrollments, groupmembership, and accountusers for the fromuser at the time of the merge. When the destinationuser launches an LTI tool from a course that used to be the fromuser's, it doesn't appear as a new user to the tool provider. Instead it will send the stored ids. The destinationuser's LTI IDs remain as they were for the courses that they originally had. Future enrollments for the destinationuser will use the IDs that are on the destinationuser object. LTI IDs that are kept and tracked per context include lticontextid, ltiid and uuid. APIs that return the LTI ids will return the one for the context that it is called for, except for the user uuid. The user UUID will display the destinationusers uuid, and when getting the uuid from an api that is in a context that was recorded from a merge event, an additional attribute is added as pastuuid. When finding users by SIS ids in different accounts the destinationaccountid is required. The account can also be identified by passing the domain in destinationaccountid.
PUT /v1/users/{id}/merge_into/accounts/{destination_account_id}/users/{destination_user_id} - Destructive
Store custom data
Store arbitrary user data as JSON. Arbitrary JSON data can be stored for a User. A typical scenario would be an external site/service that registers users in Canvas and wants to capture additional info about them. The part of the URL that follows +/customdata/+ defines the scope of the request, and it reflects the structure of the JSON data to be stored or retrieved. The value +self+ may be used for +userid+ to store data associated with the calling user. In order to access another user's custom data, you must be an account administrator with permission to manage users. A namespace parameter, +ns+, is used to prevent customdata collisions between different apps. This parameter is required for all customdata requests. A request with Content-Type multipart/form-data or Content-Type application/x-www-form-urlencoded can only be used to store strings. Example PUT with multipart/form-data data: curl 'https:// /api/v1/users/ /customdata/telephone' \ -X PUT \ -F 'ns=com.my-organization.canvas-app' \ -F 'data=555-1234' \ -H 'Authorization: Bearer ' Response: !!!javascript { "data": "555-1234" } Subscopes (or, generated scopes) can also be specified by passing values to +data+[+subscope+]. Example PUT specifying subscopes: curl 'https:// /api/v1/users/ /customdata/body/measurements' \ -X PUT \ -F 'ns=com.my-organization.canvas-app' \ -F 'data[waist]=32in' \ -F 'data[inseam]=34in' \ -F 'data[chest]=40in' \ -H 'Authorization: Bearer ' Response: !!!javascript { "data": { "chest": "40in", "waist": "32in", "inseam": "34in" } } Following such a request, subsets of the stored data to be retrieved directly from a subscope. Example {api:UsersControllergetcustomdata GET} from a generated scope curl 'https:// /api/v1/users/ /customdata/body/measurements/chest' \ -X GET \ -F 'ns=com.my-organization.canvas-app' \ -H 'Authorization: Bearer ' Response: !!!javascript { "data": "40in" } If you want to store more than just strings (i.e. numbers, arrays, hashes, true, false, and/or null), you must make a request with Content-Type application/json as in the following example. Example PUT with JSON data: curl 'https:// /api/v1/users/ /customdata' \ -H 'Content-Type: application/json' \ -X PUT \ -d '{ "ns": "com.my-organization.canvas-app", "data": { "a-number": 6.02e23, "a-bool": true, "a-string": "true", "a-hash": {"a": {"b": "ohai"}}, "an-array": [1, "two", null, false] } }' \ -H 'Authorization: Bearer ' Response: !!!javascript { "data": { "a-number": 6.02e+23, "a-bool": true, "a-string": "true", "a-hash": { "a": { "b": "ohai" } }, "an-array": [1, "two", null, false] } } If the data is an Object (as it is in the above example), then subsets of the data can be accessed by including the object's (possibly nested) keys in the scope of a GET request. Example {api:UsersControllergetcustomdata GET} with a generated scope: curl 'https:// /api/v1/users/ /customdata/a-hash/a/b' \ -X GET \ -F 'ns=com.my-organization.canvas-app' \ -H 'Authorization: Bearer ' Response: !!!javascript { "data": "ohai" } On success, this endpoint returns an object containing the data that was stored. Responds with status code 200 if the scope already contained data, and it was overwritten by the data specified in the request. Responds with status code 201 if the scope was previously empty, and the data specified in the request was successfully stored there. Responds with status code 400 if the namespace parameter, +ns+, is missing or invalid, or if the +data+ parameter is missing. Responds with status code 409 if the requested scope caused a conflict and data was not stored. This happens when storing data at the requested scope would cause data at an outer scope to be lost. e.g., if +/customdata+ was +{"fashionapp": {"hair": "blonde"}}+, but you tried to +PUT /customdata/fashionapp/hair/style -F data=buzz+, then for the request to succeed,the value of +/customdata/fashionapp/hair+ would have to become a hash, and its old string value would be lost. In this situation, an error object is returned with the following format: !!!javascript { "message": "write conflict for customdata hash", "conflictscope": "fashionapp/hair", "typeatconflict": "String", "valueatconflict": "blonde" }
PUT /v1/users/{user_id}/custom_data - Destructive
Delete custom data
Delete custom user data. Arbitrary JSON data can be stored for a User. This API call deletes that data for a given scope. Without a scope, all customdata is deleted. See {api:UsersControllersetcustomdata Store Custom Data} for details and examples of storage and retrieval. As an example, we'll store some data, then delete a subset of it. Example {api:UsersControllersetcustomdata PUT} with valid JSON data: curl 'https:// /api/v1/users/ /customdata' \ -X PUT \ -F 'ns=com.my-organization.canvas-app' \ -F 'data[fruit][apple]=so tasty' \ -F 'data[fruit][kiwi]=a bit sour' \ -F 'data[veggies][root][onion]=tear-jerking' \ -H 'Authorization: Bearer ' Response: !!!javascript { "data": { "fruit": { "apple": "so tasty", "kiwi": "a bit sour" }, "veggies": { "root": { "onion": "tear-jerking" } } } } Example DELETE: curl 'https:// /api/v1/users/ /customdata/fruit/kiwi' \ -X DELETE \ -F 'ns=com.my-organization.canvas-app' \ -H 'Authorization: Bearer ' Response: !!!javascript { "data": "a bit sour" } Example {api:UsersControllergetcustomdata GET} following the above DELETE: curl 'https:// /api/v1/users/ /customdata' \ -X GET \ -F 'ns=com.my-organization.canvas-app' \ -H 'Authorization: Bearer ' Response: !!!javascript { "data": { "fruit": { "apple": "so tasty" }, "veggies": { "root": { "onion": "tear-jerking" } } } } Note that hashes left empty after a DELETE will get removed from the customdata store. For example, following the previous commands, if we delete /customdata/veggies/root/onion, then the entire /customdata/veggies scope will be removed. Example DELETE that empties a parent scope: curl 'https:// /api/v1/users/ /customdata/veggies/root/onion' \ -X DELETE \ -F 'ns=com.my-organization.canvas-app' \ -H 'Authorization: Bearer ' Response: !!!javascript { "data": "tear-jerking" } Example {api:UsersControllergetcustomdata GET} following the above DELETE: curl 'https:// /api/v1/users/ /customdata' \ -X GET \ -F 'ns=com.my-organization.canvas-app' \ -H 'Authorization: Bearer ' Response: !!!javascript { "data": { "fruit": { "apple": "so tasty" } } } On success, this endpoint returns an object containing the data that was deleted. Responds with status code 400 if the namespace parameter, +ns+, is missing or invalid, or if the specified scope does not contain any data.
DELETE /v1/users/{user_id}/custom_data - Destructive
Set course nickname
Set a nickname for the given course. This will replace the course's name in output of API calls you make subsequently, as well as in selected places in the Canvas web user interface.
PUT /v1/users/self/course_nicknames/{course_id} - Destructive
Remove course nickname
Remove the nickname for the given course. Subsequent course API calls will return the actual name for the course.
DELETE /v1/users/self/course_nicknames/{course_id} - Destructive
Clear course nicknames
Remove all stored course nicknames.
DELETE /v1/users/self/course_nicknames
Webhooks Subscriptions for Plagiarism Platform
- Read
Show a single Webhook Subscription
Show a single Webhook Subscription
GET /lti/subscriptions/{id} - Read
List all Webhook Subscription for a tool proxy
This endpoint returns a paginated list with a default limit of 100 items per result set. You can retrieve the next result set by setting a 'StartKey' header in your next request with the value of the 'EndKey' header in the response. Example use of a 'StartKey' header object: { "Id":"71d6dfba-0547-477d-b41d-db8cb528c6d1","DeveloperKey":"10000000000001" }
GET /lti/subscriptions - Write
Create a Webhook Subscription
Creates a webook subscription for the specified event type and context.
POST /lti/subscriptions - Destructive
Delete a Webhook Subscription
Delete a Webhook Subscription
DELETE /lti/subscriptions/{id} - Destructive
Update a Webhook Subscription
This endpoint uses the same parameters as the create endpoint
PUT /lti/subscriptions/{id}
What If Grades
- Destructive
Update a submission's what-if score and calculate grades
Enter a what if score for a submission and receive the calculated grades Grade calculation is a costly operation, so this API should be used sparingly
PUT /v1/submissions/{id}/what_if_grades - Destructive
Reset the what-if scores for the current user for an entire course and recalculate grades
Resets all what-if scores for a student in a course and recalculates grades.
PUT /v1/courses/{course_id}/what_if_grades/reset
No operations match.
Get started
- Open Space settings → Connections and search for Canvas.
- Connect your account and add the connection to the Space.
- Ask for what you need in any thread in that Space.
See How connections work for access and permissions, or browse all integrations.