Skip to main content
Every canvas.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.
New to Corsair? See API access, authentication, and error handling.

​
Accounts

​
closeNotificationForUser

accounts.closeNotificationForUser Close an account notification for the current user Risk: destructive
Input
Output: object

​
createAccountNotification

accounts.createAccountNotification Creates a global notification within a Canvas account Risk: write
Input
Output

​
getAccountGraphQl

accounts.getAccountGraphQl Call Canvas GraphQL (/api/graphql); supply the query document and variables in input.body Risk: write
Input
Output
accounts.getAccountHelpLinks Retrieves help links configured for the specified Canvas account Risk: read
Input
Output: object

​
getAccountNotifications

accounts.getAccountNotifications Retrieve global account notifications for the current user Risk: read
Input
Output: object[]

​
getAccountsThatUsersCanCreateCoursesIn

accounts.getAccountsThatUsersCanCreateCoursesIn Retrieves Canvas accounts where the current user can create courses Risk: read
Input
Output: object[]

​
getSingleAccount

accounts.getSingleAccount Retrieve information on an individual account by ID Risk: read
Input
Output

​
Appointment Groups

​
createAppointmentGroup

appointmentGroups.createAppointmentGroup Creates a new appointment group in Canvas Risk: write
Input
Output

​
deleteAppointmentGroup

appointmentGroups.deleteAppointmentGroup Permanently deletes an existing appointment group Risk: destructive
Input
Output: object

​
Assignment Groups

​
createAssignmentGroup

assignmentGroups.createAssignmentGroup Create a new assignment group for a course Risk: write
Input
Output

​
getAnAssignmentGroup

assignmentGroups.getAnAssignmentGroup Retrieves the assignment group with the given id Risk: read
Input
Output

​
getAssignmentGroup

assignmentGroups.getAssignmentGroup Retrieve information about a specific assignment group by ID Risk: write
Input
Output

​
Assignment Overrides

​
createAssignmentOverride

assignmentOverrides.createAssignmentOverride Creates an assignment override to adjust due/unlock/lock dates Risk: write
Input
Output

​
createBatchOverridesInACourse

assignmentOverrides.createBatchOverridesInACourse Batch create assignment overrides for multiple assignments in a course Risk: write
Input
Output: object[]

​
deleteAssignmentOverride

assignmentOverrides.deleteAssignmentOverride Deletes an assignment override and returns its former details Risk: destructive
Input
Output: object

​
getCourses12Assignments

assignmentOverrides.getCourses12Assignments Batch retrieve assignment overrides in a course Risk: read
Input
Output: object[]

​
getSingleAssignmentOverride

assignmentOverrides.getSingleAssignmentOverride Retrieves details of the assignment override with the given id Risk: read
Input
Output

​
Assignments

​
createAssignment

assignments.createAssignment Creates a new assignment within a specified course in Canvas LMS Risk: write
Input
Output

​
createAssignmentGraphQl

assignments.createAssignmentGraphQl Call Canvas GraphQL (/api/graphql); supply the mutation document and variables in input.body Risk: write
Input
Output

​
deleteAssignment

assignments.deleteAssignment Soft-deletes a specific assignment within a course Risk: destructive
Input
Output: object

​
editAssignment

assignments.editAssignment Updates an existing assignment in a Canvas course Risk: write
Input
Output

​
getAllAssignments

assignments.getAllAssignments Retrieves assignments for a specific Canvas course Risk: read
Input
Output: object[]

​
getAssignment

assignments.getAssignment Retrieves detailed information for a specific assignment Risk: read
Input
Output

​
getAssignment2

assignments.getAssignment2 Call Canvas GraphQL (/api/graphql); supply the query document and variables in input.body Risk: write
Input
Output

​
getSubmissionSummary

assignments.getSubmissionSummary Retrieves submission summary counts for a specific assignment Risk: read
Input
Output

​
Audit Reports

​
getAuditLogs

auditReports.getAuditLogs Access Canvas audit logs for a specified asset using GraphQL Risk: write
Input
Output

​
getStatusOfLastReport

auditReports.getStatusOfLastReport Retrieve the status of the last generated report for a course Risk: read
Input
Output: object

​
Authentication

​
getAuthenticationProvider

authentication.getAuthenticationProvider Retrieves a specific authentication provider configuration Risk: read
Input
Output

​
Blackout Dates

​
createBlackoutDateForCourse

blackoutDates.createBlackoutDateForCourse Create a blackout date for the given course context Risk: write
Input
Output

​
deleteBlackoutDate

blackoutDates.deleteBlackoutDate Delete a blackout date for the given course context Risk: destructive
Input
Output: object

​
Blueprints

​
getCoursesBlueprint

blueprints.getCoursesBlueprint Retrieves blueprint subscription migrations for a Canvas course Risk: read
Input
Output: object[]

​
Bookmarks

​
createBookmark

bookmarks.createBookmark Creates a new bookmark for the authenticated user Risk: write
Input
Output

​
deleteBookmark

bookmarks.deleteBookmark Deletes a bookmark from the current user bookmarks Risk: destructive
Input
Output: object

​
getBookmark

bookmarks.getBookmark Retrieves the details for a specific bookmark by ID Risk: read
Input
Output

​
Brand Config

​
getBrandVariables

brandConfig.getBrandVariables Retrieve all brand configuration variables for the Canvas account Risk: read
Input
Output: object

​
getInternalSettings

brandConfig.getInternalSettings Retrieve all internal settings from Canvas using GraphQL Risk: write
Input
Output

​
getKalturaConfig

brandConfig.getKalturaConfig Return the config information for the Kaltura plugin Risk: read
Input
Output: object

​
Calendar Events

​
createCalendarEvent

calendarEvents.createCalendarEvent Creates a calendar event with options for recurrence Risk: write
Input
Output

​
createOrUpdateTimetableEvents

calendarEvents.createOrUpdateTimetableEvents Create or update timetable events for a course or section Risk: write
Input
Output

​
deleteCalendarEvent

calendarEvents.deleteCalendarEvent Delete a calendar event from Canvas Risk: destructive
Input
Output: object

​
Comment Bank

​
deleteCommentBankItem

commentBank.deleteCommentBankItem Delete a comment bank item from Canvas Risk: destructive
Input
Output: object

​
Communication Channels

​
createCommunicationChannel

communicationChannels.createCommunicationChannel Creates a new communication channel for an existing Canvas user Risk: write
Input
Output

​
deleteCommunicationChannel

communicationChannels.deleteCommunicationChannel Deletes an existing communication channel for a user Risk: destructive
Input
Output: object

​
deleteCommunicationChannelByTypeAndAddress

communicationChannels.deleteCommunicationChannelByTypeAndAddress Deletes a communication channel by type and address Risk: destructive
Input
Output: object

​
Content Exports

​
exportContent

contentExports.exportContent Initiates an asynchronous export of course content from Canvas Risk: write
Input
Output

​
exportGroupContent

contentExports.exportGroupContent Begin a content export job for a group Risk: write
Input
Output

​
exportUserContent

contentExports.exportUserContent Begin a content export job for a user Risk: write
Input
Output

​
Content Migrations

​
createAContentMigration4

contentMigrations.createAContentMigration4 Create a content migration for a Canvas user Risk: write
Input
Output

​
createGroupContentMigration

contentMigrations.createGroupContentMigration Create a content migration in a Canvas group Risk: write
Input
Output

​
getAContentMigration3

contentMigrations.getAContentMigration3 Retrieve data on an individual content migration from a group Risk: read
Input
Output

​
getAContentMigration4

contentMigrations.getAContentMigration4 Retrieve data on an individual content migration from a user Risk: read
Input
Output

​
Content Shares

​
addUsersToContentShare

contentShares.addUsersToContentShare Send a previously created content share to additional users Risk: write
Input
Output

​
createContentShare

contentShares.createContentShare Shares a Canvas content item to specified users Risk: write
Input
Output

​
getContentShare

contentShares.getContentShare Retrieves detailed information about a single content share Risk: read
Input
Output

​
getContentSharesUnreadCount

contentShares.getContentSharesUnreadCount Retrieve the count of unread content shares for the authenticated user Risk: read
Input
Output

​
Conversations

​
addConversationMessage

conversations.addConversationMessage Add a message to an existing Canvas conversation Risk: write
Input
Output

​
addRecipientsToConversation

conversations.addRecipientsToConversation Add recipients to an existing group conversation Risk: write
Input
Output

​
createConversation

conversations.createConversation Send messages in Canvas by creating a new conversation Risk: write
Input
Output

​
createConversationGraphQl

conversations.createConversationGraphQl Create a new conversation between users in Canvas via GraphQL Risk: write
Input
Output

​
deleteConversationMessages

conversations.deleteConversationMessages Delete specific messages from a Canvas conversation Risk: write
Input
Output

​
deleteConversations

conversations.deleteConversations Delete one or more Canvas conversations Risk: destructive
Input
Output: object

​
editConversation

conversations.editConversation Update attributes for a single conversation in Canvas Risk: write
Input
Output

​
findRecipients

conversations.findRecipients Find valid recipients that the current user can send messages to Risk: read
Input
Output: object[]

​
getSingleConversation

conversations.getSingleConversation Retrieve detailed information for a single conversation Risk: read
Input
Output

​
getUnreadCount

conversations.getUnreadCount Get the number of unread conversations for the current user Risk: read
Input
Output

​
Course Nicknames

​
clearCourseNicknames

courseNicknames.clearCourseNicknames Remove all stored course nicknames for the current user Risk: destructive
Input
Output: object

​
Courses

​
addCourseToFavorites

courses.addCourseToFavorites Add a course to the current user favorites Risk: write
Input
Output

​
createCourse

courses.createCourse Create a new course in Canvas within a specified account Risk: write
Input
Output

​
getAccountCourse

courses.getAccountCourse Retrieve information on a single course from a Canvas account Risk: read
Input
Output

​
getCourseLevelParticipationData

courses.getCourseLevelParticipationData Retrieves daily activity analytics for a specified Canvas course Risk: read
Input
Output: any[]

​
getCoursePermissions

courses.getCoursePermissions Returns permission information for the calling user in the given course Risk: read
Input
Output: object

​
getSingleCourse

courses.getSingleCourse Retrieve detailed information for a specific Canvas course Risk: read
Input
Output

​
Discussions

​
createDiscussionEntry

discussions.createDiscussionEntry Create a new entry in a Canvas discussion topic Risk: write
Input
Output

​
createDiscussionEntryGraphQl

discussions.createDiscussionEntryGraphQl Create a new entry in a Canvas discussion topic via GraphQL Risk: write
Input
Output

​
createDiscussionTopic

discussions.createDiscussionTopic Creates a new discussion topic in a specified Canvas course Risk: write
Input
Output

​
createDiscussionTopicGraphQl

discussions.createDiscussionTopicGraphQl Create a new discussion topic via GraphQL API Risk: write
Input
Output

​
deleteAnEntry

discussions.deleteAnEntry Delete a discussion entry Risk: destructive
Input
Output: object

​
deleteDiscussionEntry

discussions.deleteDiscussionEntry Delete a discussion entry via GraphQL Risk: destructive
Input
Output

​
deleteDiscussionTopicGraphQl

discussions.deleteDiscussionTopicGraphQl Delete a discussion topic in Canvas via GraphQL Risk: destructive
Input
Output

​
getSingleTopic

discussions.getSingleTopic Retrieve detailed information about a single discussion topic Risk: read
Input
Output

​
Enrollments

​
addLastAttendedDate

enrollments.addLastAttendedDate Add or update the last attended date for a student enrollment Risk: write
Input
Output

​
concludeDeactivateOrDeleteEnrollment

enrollments.concludeDeactivateOrDeleteEnrollment Conclude, deactivate, or delete an enrollment in a Canvas course Risk: destructive
Input
Output: object

​
createEnrollment

enrollments.createEnrollment Enrolls a user in a Canvas course with a specified role and status Risk: write
Input
Output

​
getEnrollmentInvitations

enrollments.getEnrollmentInvitations Retrieve pending enrollment invitations for the current user Risk: read
Input
Output: object[]

​
E Portfolios

​
getAllEPortfoliosForUser

ePortfolios.getAllEPortfoliosForUser Retrieve all ePortfolios for a specified user Risk: read
Input
Output: object[]

​
Epub Exports

​
createEpubExport

epubExports.createEpubExport Initiate an ePub export for a course Risk: write
Input
Output

​
External Feeds

​
createExternalFeed

externalFeeds.createExternalFeed Creates a new external RSS or Atom feed for a Canvas course Risk: write
Input
Output

​
createExternalFeedForGroup

externalFeeds.createExternalFeedForGroup Create a new external RSS or Atom feed for a Canvas group Risk: write
Input
Output

​
deleteExternalFeedFromGroup

externalFeeds.deleteExternalFeedFromGroup Deletes the external feed from the specified group Risk: destructive
Input
Output: object

​
External Tools

​
createExternalTool

externalTools.createExternalTool Create an external tool in a Canvas account Risk: write
Input
Output

​
createExternalToolInCourse

externalTools.createExternalToolInCourse Create an external tool in a Canvas course Risk: write
Input
Output
externalTools.createLtiResourceLink Creates a new LTI Resource Link in a Canvas course Risk: write
Input
Output

​
deleteAnExternalTool

externalTools.deleteAnExternalTool Remove the specified external tool from a course Risk: destructive
Input
Output: object

​
getASingleExternalTool2

externalTools.getASingleExternalTool2 Retrieve detailed information for a specific external tool in a course Risk: read
Input
Output

​
getSingleExternalTool

externalTools.getSingleExternalTool Retrieve detailed information for a specific external tool Risk: read
Input
Output

​
Fetch Data

​
fetchData

fetchData.fetchData Fetches a specific category of Canvas data (accounts, courses, users, etc.) Risk: read
Input
Output

​
Files

​
copyFileToFolder

files.copyFileToFolder Copies an existing Canvas file to a specified destination folder Risk: write
Input
Output

​
copyFolder

files.copyFolder Copy a folder to another folder in Canvas Risk: write
Input
Output

​
createFiles

files.createFiles Initiate file upload to Canvas (Step 1 of 3-step process) Risk: write
Input
Output

​
createFolder

files.createFolder Create a folder in the specified context for a user Risk: write
Input
Output

​
createFolderInGroup

files.createFolderInGroup Create a folder within a Canvas group Risk: write
Input
Output

​
deleteFile

files.deleteFile Remove a file from Canvas Risk: destructive
Input
Output: object

​
deleteFolder

files.deleteFolder Permanently deletes an existing folder Risk: destructive
Input
Output: object

​
getFolderById

files.getFolderById Retrieves the details for a specific folder by its ID Risk: read
Input
Output

​
getGroupFolder

files.getGroupFolder Retrieves the details for a folder within a Canvas group Risk: read
Input
Output

​
getQuotaInformation

files.getQuotaInformation Retrieves the total and used storage quota for a Canvas user Risk: read
Input
Output

​
Gradebook Columns

​
createCustomGradebookColumn

gradebookColumns.createCustomGradebookColumn Creates a new custom gradebook column in a course Risk: write
Input
Output

​
deleteCustomGradebookColumn

gradebookColumns.deleteCustomGradebookColumn Permanently deletes a custom gradebook column Risk: destructive
Input
Output: object

​
updateCustomGradebookColumnData

gradebookColumns.updateCustomGradebookColumnData Bulk updates custom gradebook column data for multiple students Risk: write
Input
Output

​
Grading

​
createCourseGradingStandard

grading.createCourseGradingStandard Create a new grading standard in a Canvas course Risk: write
Input
Output

​
deleteCustomGradeStatus

grading.deleteCustomGradeStatus Delete a custom grade status from Canvas Risk: destructive
Input
Output: object

​
getSingleGradingStandardIn2

grading.getSingleGradingStandardIn2 Retrieves a single grading standard for the given course context Risk: read
Input
Output

​
Graphql

​
getLegacyNode

graphql.getLegacyNode Call Canvas GraphQL (/api/graphql); supply the query document and variables in input.body Risk: write
Input
Output

​
Group Categories

​
assignUnassignedMembersToGroupCategory

groupCategories.assignUnassignedMembersToGroupCategory Assign unassigned members to groups within a group category Risk: write
Input
Output

​
createGroupCategoryCourses

groupCategories.createGroupCategoryCourses Creates a new group category within a specified Canvas course Risk: write
Input
Output

​
createGroupInSet

groupCategories.createGroupInSet Create a new group within a Canvas group set Risk: write
Input
Output

​
createGroupSet

groupCategories.createGroupSet Create a new group set (group category) in a Canvas account Risk: write
Input
Output

​
Group Discussions

​
createGroupDiscussionTopic

groupDiscussions.createGroupDiscussionTopic Create a new discussion topic in a Canvas group Risk: write
Input
Output

​
deleteAnEntry2

groupDiscussions.deleteAnEntry2 Delete a discussion entry in a group discussion Risk: destructive
Input
Output: object

​
deleteGroupDiscussionTopic

groupDiscussions.deleteGroupDiscussionTopic Deletes a discussion topic from a group Risk: destructive
Input
Output: object

​
duplicateGroupDiscussionTopic

groupDiscussions.duplicateGroupDiscussionTopic Duplicate an existing discussion topic in a Canvas group Risk: write
Input
Output

​
getFullTopicGroups

groupDiscussions.getFullTopicGroups Retrieve the full cached structure of a group discussion topic Risk: read
Input
Output: object

​
getSingleTopic2

groupDiscussions.getSingleTopic2 Retrieve detailed information about a single group discussion topic Risk: read
Input
Output

​
Group Memberships

​
createMembership

groupMemberships.createMembership Join or request to join a group Risk: write
Input
Output

​
getASingleGroupMembership

groupMemberships.getASingleGroupMembership Retrieve a single group membership by its membership_id Risk: read
Input
Output

​
getASingleGroupMembership2

groupMemberships.getASingleGroupMembership2 Retrieve a single group membership by user_id Risk: read
Input
Output

​
Groups

​
addGroupToFavorites

groups.addGroupToFavorites Add a group to the current user favorites Risk: write
Input
Output

​
createGroup

groups.createGroup Create a new community group directly Risk: write
Input
Output

​
deleteGroup

groups.deleteGroup Deletes a group and removes all members Risk: destructive
Input
Output: object

​
getGroup

groups.getGroup Retrieves detailed information for a single Canvas group Risk: read
Input
Output

​
getGroupActivityStreamSummary

groups.getGroupActivityStreamSummary Retrieves a summary of the group-specific activity stream Risk: read
Input
Output: any[]

​
getGroupPermissions

groups.getGroupPermissions Returns permission information for the calling user in the group Risk: read
Input
Output: object

​
Late Policy

​
getALatePolicy

latePolicy.getALatePolicy Retrieve the late policy for a Canvas course Risk: read
Input
Output: object

​
Modules

​
createModule

modules.createModule Creates a new organizational module within a specified Canvas LMS course Risk: write
Input
Output

​
createModuleGraphQl

modules.createModuleGraphQl Create a new module in a Canvas course via GraphQL Risk: write
Input
Output

​
createModuleItem

modules.createModuleItem Create and return a new module item within a Canvas course module Risk: write
Input
Output

​
getModuleItem

modules.getModuleItem Retrieve information about a specific module item by ID using GraphQL Risk: write
Input
Output

​
getModuleItemSequence

modules.getModuleItemSequence Find the module item sequence for a given asset in a Canvas course Risk: read
Input
Output: object

​
Outcome Groups

​
createLinkOutcomeCourses

outcomeGroups.createLinkOutcomeCourses Link an existing outcome or create a new outcome within a course Risk: write
Input
Output

​
createSubgroupCourses

outcomeGroups.createSubgroupCourses Creates a new empty subgroup under the outcome group Risk: write
Input
Output

​
deleteAnOutcomeGroupCourses

outcomeGroups.deleteAnOutcomeGroupCourses Deletes an outcome group from a course Risk: destructive
Input
Output: object

​
getAccountsOutcomeGroups

outcomeGroups.getAccountsOutcomeGroups Retrieve a specific outcome group from a Canvas account Risk: read
Input
Output

​
getAllOutcomeGroupsForContext

outcomeGroups.getAllOutcomeGroupsForContext Retrieve all outcome groups for an account context Risk: read
Input
Output: object[]

​
getAllOutcomeGroupsForContext2

outcomeGroups.getAllOutcomeGroupsForContext2 Retrieve all outcome groups for a course context Risk: read
Input
Output: object[]

​
getAllOutcomeLinksForContext

outcomeGroups.getAllOutcomeLinksForContext Retrieves all outcome links for an account context Risk: read
Input
Output: object[]

​
getAllOutcomeLinksForContext2

outcomeGroups.getAllOutcomeLinksForContext2 Retrieves all outcome links for a course context Risk: read
Input
Output: object[]

​
getGlobalOutcomeGroup

outcomeGroups.getGlobalOutcomeGroup Retrieves a global outcome group by ID from Canvas Risk: read
Input
Output

​
getRootOutcomeGroupForCourse

outcomeGroups.getRootOutcomeGroupForCourse Retrieves the root outcome group for a specified course context Risk: read
Input
Output

​
Outcomes

​
createLearningOutcome

outcomes.createLearningOutcome Create a new learning outcome in Canvas using GraphQL Risk: write
Input
Output
outcomes.deleteOutcomeLinks Delete links between outcomes and content in Canvas Risk: destructive
Input
Output

​
getAlignedAssignmentsForAnOutcome

outcomes.getAlignedAssignmentsForAnOutcome Retrieves outcome alignments for a student or assignment Risk: read
Input
Output: object[]

​
getOutcomeResults

outcomes.getOutcomeResults Get outcome results for users and outcomes in a course context Risk: read
Input
Output

​
Pages

​
createPageForCourse

pages.createPageForCourse Creates a new wiki page in a specified Canvas course Risk: write
Input
Output

​
createPageForGroup

pages.createPageForGroup Creates a new wiki page in a specified Canvas group Risk: write
Input
Output

​
deletePageForGroup

pages.deletePageForGroup Deletes a wiki page from a Canvas group Risk: destructive
Input
Output: object

​
getPageForCourse

pages.getPageForCourse Retrieves a specific content page by its URL or ID from a course Risk: read
Input
Output

​
Peer Reviews

​
getAllPeerReviews

peerReviews.getAllPeerReviews Retrieves all peer reviews for a specific submission Risk: read
Input
Output: object[]

​
getAllPeerReviewsForSectionAssignment

peerReviews.getAllPeerReviewsForSectionAssignment Retrieves all peer reviews for a specific assignment within a section Risk: read
Input
Output: object[]

​
getAllPeerReviewsForSectionSubmission

peerReviews.getAllPeerReviewsForSectionSubmission Retrieves all peer reviews for a specific submission within a section Risk: read
Input
Output: object[]

​
Planner

​
createPlannerNote

planner.createPlannerNote Create a planner note for the current user Risk: write
Input
Output

​
createPlannerOverride

planner.createPlannerOverride Create a planner override for the current user Risk: write
Input
Output

​
deletePlannerNote

planner.deletePlannerNote Delete a planner note for the current user Risk: destructive
Input
Output: object

​
deletePlannerOverride

planner.deletePlannerOverride Delete a planner override for the current user Risk: destructive
Input
Output: object

​
Polls

​
createSinglePoll

polls.createSinglePoll Create a new poll for the current user in Canvas Risk: write
Input
Output

​
createSinglePollChoice

polls.createSinglePollChoice Create one or more poll choices for an existing poll Risk: write
Input
Output

​
createSinglePollSession

polls.createSinglePollSession Create a new poll session for a poll in Canvas Risk: write
Input
Output

​
createSinglePollSubmission

polls.createSinglePollSubmission Create a new poll submission for a poll session Risk: write
Input
Output

​
deletePoll

polls.deletePoll Permanently deletes the poll identified by id Risk: destructive
Input
Output: object

​
deletePollChoice

polls.deletePollChoice Delete a poll choice from a Canvas poll Risk: destructive
Input