Help Center

Menu

Actions

Calendar events

API documentation is available at https://canvas.instructure.com/doc/api/calendar_events.html.

Create calendar event

This action creates and returns a new calendar event with the provided details.

Input fields

  • contextCode

  • title

  • startDate

  • endDate

  • description

  • location

Delete calendar event

This action deletes the calendar event with the specified ID.

Input fields

  • ID

  • cancelReason

Get calendar events

This action retrieves a paginated list of calendar events for the current user.

Input fields

  • startDate

  • endDate

  • contextCodes

Get calendar event by ID

This action retrieves the single calendar event with the provided ID.

Input fields

  • ID

Update calendar event

This action updates and returns the calendar event with the provided details.

Input fields

  • ID

  • contextCode

  • title

  • startDate

  • endDate

  • description

  • location

Courses

API documentation is available at https://canvas.instructure.com/doc/api/courses.html.

Get course (one only)

This action retrieves the course with the provided ID.

Input fields

  • courseId

Get courses

This action retrieves the paginated list of all courses for the selected account.

Input fields

  • accountId

  • state

Assignments

API documentation is available at https://canvas.instructure.com/doc/api/assignments.html.

Get assignment (one only)

This action retrieves the assignment with the provided ID for the specified course.

Input fields

  • courseId

  • assignmentId

  • include

Get assignments for course

This action retrieves the paginated list of all assignments for the specified course.

Input fields

  • courseId

Files

API documentation is available at https://canvas.instructure.com/doc/api/files.html.

Get file (one only)

This action retrieves the file with the provided ID for the specified course.

Input fields

  • courseId

  • fileId

Get files for course

This action retrieves the paginated list of all files for the specified course.

Input fields

  • courseId

Users

API documentation is available at https://canvas.instructure.com/doc/api/users.html.

Get user

This action retrieves the details of the specified user.

Input fields

  • userId

  • sisUserId

Search all users

This action retrieves a paginated list of all of the Users matching the specified criteria.

Input fields

  • accountId

  • searchTerm

  • enrollmentType

  • sortBy

  • order

  • resultsPerPage

Enrollments

API documentation is available at https://canvas.instructure.com/doc/api/enrollments.html.

Get user enrollments

This action retrieves a paginated list of all of the specified user’s enrollments.

Input fields

  • userId

  • sisUserId

  • state

Announcements

API documentation is available at https://canvas.instructure.com/doc/api/announcements.html.

Get announcements

Returns the paginated list of announcements for the given courses and date range.

A context_code field is added to the responses to identify to which course each announcement belongs.

Input fields

  • startDate

  • endDate

  • contextCode

  • active_only

  • include

Sections

API documentation is available at https://canvas.instructure.com/doc/api/sections.html.

Get section by ID

Returns the specified section.

Input fields

  • sectionId

  • courseId

  • include

Discussion topics

API documentation is available at https://canvas.instructure.com/doc/api/discussion_topics.html.

Get discussion topics

Lists the discussion topics for the specified owning entity.

Input fields

  • owningEntityType

  • owningEntityId

  • include

  • orderBy

  • scope

  • onlyAnnouncements

  • filterBy

  • searchTerm

  • excludeContextModuleLockedTopics

  • perPage

  • page

Get discussion topic by topic ID

Returns the specified discussion topic.

Input fields

  • owningEntityType

  • owningEntityId

  • topicId

  • include

Clean data

Generate an object with clean ID

Return an object with clean ID and other event related fields.

This clean ID is a Canvas event ID with the tenant ID removed leaving only the object ID which is usable in subsequent requests.

Input fields

  • eventName

  • rootAccountId

  • objectId

  • objectType

  • workflowState