Instructure Developer Documentation Portal
Community
  • Introduction
  • Services
    • Elevate Standards Alignment - AB Connect API
      • Introduction
        • Authentication
        • Addressing Object Properties
        • Requesting Additional Properties in the Response
        • Filtering Using ODATA Like Statements
        • Sorting
        • Facets
        • Paging Data
        • Call Throttling
        • Working with Related Object
        • Error Responses
        • Character Set Support
        • How To Articles, Recommendations and Suggestions
        • Examples
        • Using AB Connect's Embeddable Widgets
      • Reference
        • Standards
        • Standard Collections
        • Events
        • Topics
        • Concepts
        • Assets
        • Asset Definitions
        • Asset Collections
        • Managing and Predicting Relationships
        • Providers
    • Canvas LMS
      • Basics
        • GraphQL
        • API Change Log
        • SIS IDs
        • Pagination
        • Throttling
        • Compound Documents
        • File Uploads
        • API Endpoint Attributes
        • Masquerading
      • OAuth2
        • OAuth2 Overview
        • OAuth2 Endpoints
        • Developer Keys
      • Resources
        • Access Tokens
        • Account Calendars
        • Account Domain Lookups
        • Account Notifications
        • Account Reports
        • Accounts
        • Accounts (LTI)
        • Admins
        • Analytics
        • Announcement External Feeds
        • Announcements
        • API Token Scopes
        • Appointment Groups
        • Assignment Extensions
        • Assignment Groups
        • Assignments
        • Authentication Providers
        • Authentications Log
        • Blackout Dates
        • BlockEditorTemplate
        • Blueprint Courses
        • Bookmarks
        • Brand Configs
        • Calendar Events
        • Collaborations
        • CommMessages
        • Communication Channels
        • Conferences
        • Content Exports
        • Content Migrations
        • Content Security Policy Settings
        • Content Shares
        • Conversations
        • Course Audit log
        • Course Pace
        • Course Quiz Extensions
        • Course Reports
        • Courses
        • Custom Gradebook Columns
        • Developer Key Account Bindings
        • Developer Keys
        • Discussion Topics
        • Enrollment Terms
        • Enrollments
        • ePortfolios
        • ePub Exports
        • Error Reports
        • External Tools
        • Favorites
        • Feature Flags
        • Files
        • Grade Change Log
        • Gradebook History
        • Grading Period Sets
        • Grading Periods
        • Grading Standards
        • Group Categories
        • Groups
        • History
        • InstAccess tokens
        • JWTs
        • Late Policy
        • Learning Object Dates
        • Line Items
        • LiveAssessments
        • Logins
        • LTI Launch Definitions
        • LTI Registrations
        • LTI Resource Links
        • Media Objects
        • Moderated Grading
        • Modules
        • Names and Role
        • New Quiz Items
        • New Quizzes
        • New Quizzes Accommodations
        • New Quizzes Reports
        • Notification Preferences
        • Originality Reports
        • Outcome Groups
        • Outcome Imports
        • Outcome Results
        • Outcomes
        • Pages
        • Peer Reviews
        • Planner
        • Poll Sessions
        • PollChoices
        • Polls
        • PollSubmissions
        • Proficiency Ratings
        • Progress
        • Public JWK
        • Quiz Assignment Overrides
        • Quiz Extensions
        • Quiz IP Filters
        • Quiz Question Groups
        • Quiz Questions
        • Quiz Reports
        • Quiz Statistics
        • Quiz Submission Events
        • Quiz Submission Files
        • Quiz Submission Questions
        • Quiz Submission User List
        • Quiz Submissions
        • Quizzes
        • Result
        • Roles
        • Rubrics
        • Sandboxes
        • Score
        • Search
        • Sections
        • Services
        • Shared Brand Configs
        • SIS Import Errors
        • SIS Imports
        • SIS Integration
        • Smart Search
        • Submission Comments
        • Submissions
        • Tabs
        • Temporary Enrollment Pairings
        • User Observees
        • Users
        • What If Grades
      • Outcomes
        • Outcomes CSV Format
      • Group Categories
        • Group Categories CSV Format
      • SIS
        • SIS CSV Format
      • External Tools
        • LTI
          • Introduction
          • Registration
          • Launch Overview
          • Configuring
          • Variable Substitutions
          • Deep Linking
          • Grading
          • Provisioning
          • PostMessage
          • Platform Notification Service
          • Placements
            • Placements Overview
            • Navigation
            • Homework Submission
            • Editor Button
            • Migration Selection
            • Link Selection (Modules)
            • Assignment Selection
            • Collaborations
        • xAPI
        • Canvas Roles
        • Plagiarism Detection Platform
          • Overview
          • Plagiarism Detection Platform Assignments
          • Plagiarism Detection Platform Users
          • Plagiarism Detection Submissions
          • Webhooks Subscriptions for Plagiarism Platform
          • JWT Access Tokens
      • Data Services
        • Live Events
          • Overview
            • Introduction
            • Setup
            • Caliper
            • Metadata
          • Event Format
            • Canvas
              • Account
              • Asset
              • Assignment
              • Attachment
              • Content
              • Conversation
              • Course
              • Discussion
              • Enrollment
              • Grade
              • Group
              • Learning
              • Logged
              • Module
              • Outcome
              • Outcomes
              • Plagiarism
              • Quiz
              • Rubric
              • Sis
              • Submission
              • Syllabus
              • User
              • Wiki
            • Caliper IMS 1.1
              • Assessment
              • Basic
              • Forum
              • Grading
              • Navigation Events
              • Session
    • Catalog
      • APIs
        • Analytics
        • Bulk Enrollments
        • Catalogs
        • Certificates
        • Completed Certificates
        • Courses
        • Email Domain Set
        • Enrollments
        • Orders
        • Programs
        • Progresses
        • Tags
        • User Registrations
        • Users
        • Waitlist Applicants
    • Credentials
      • Getting Started
      • Authentication
        • Password-Based Authentication
        • Authorization Code-Based Authentication
      • Pagination
      • APIs
        • Assertions
        • Backpack
        • Badgeclasses
        • Issuers
        • Organizations
        • Users
      • Release Notes
    • Data Access Platform
      • Key Concepts
      • Data Formats
      • Rate Limits & Policies
      • Datasets
        • Namespaces
          • canvas
            • canvas types
          • canvas_logs
          • catalog
        • Additional Notes
        • Entity Relationship Diagram
      • Query API
        • Authentication
        • Reference
      • Command Line (DAP CLI)
        • Getting Started
        • Secure Connection
        • Reference
          • dap snapshot
          • dap incremental
          • dap list
          • dap schema
          • dap initdb
          • dap syncdb
          • dap dropdb
      • Client Library
        • Examples
        • Reference
      • Release Notes
      • Status
    • DataSync
      • Interop API
      • Interop Data API
      • Grades Exchange API
      • OneRoster API
      • Platform API
    • Instructure Media
      • Studio API
    • Quizzes
      • Quiz API
Powered by GitBook

Copyright © 2008-2024 Instructure, Inc. All rights reserved. Various trademarks held by their respective owners.

On this page
  • List planner items
  • List planner notes
  • Show a planner note
  • Update a planner note
  • Create a planner note
  • Delete a planner note
  • List planner overrides
  • Show a planner override
  • Update a planner override
  • Create a planner override
  • Delete a planner override

Was this helpful?

  1. Services
  2. Canvas LMS
  3. Resources

Planner

API for listing learning objects to display on the student planner and calendar

API for creating, accessing and updating Planner Notes. PlannerNote are used to set reminders and notes to self about courses or general events.

API for creating, accessing and updating planner override. PlannerOverrides are used to control the visibility of objects displayed on the Planner.

A PlannerNote object looks like:

// A planner note
{
  // The ID of the planner note
  "id": 234,
  // The title for a planner note
  "title": "Bring books tomorrow",
  // The description of the planner note
  "description": "I need to bring books tomorrow for my course on biology",
  // The id of the associated user creating the planner note
  "user_id": 1578941,
  // The current published state of the planner note
  "workflow_state": "active",
  // The course that the note is in relation too, if applicable
  "course_id": 1578941,
  // The datetime of when the planner note should show up on their planner
  "todo_date": "2017-05-09T10:12:00Z",
  // the type of the linked learning object
  "linked_object_type": "assignment",
  // the id of the linked learning object
  "linked_object_id": 131072,
  // the Canvas web URL of the linked learning object
  "linked_object_html_url": "https://canvas.example.com/courses/1578941/assignments/131072",
  // the API URL of the linked learning object
  "linked_object_url": "https://canvas.example.com/api/v1/courses/1578941/assignments/131072"
}

A PlannerOverride object looks like:

// User-controlled setting for whether an item should be displayed on the
// planner or not
{
  // The ID of the planner override
  "id": 234,
  // The type of the associated object for the planner override
  "plannable_type": "Assignment",
  // The id of the associated object for the planner override
  "plannable_id": 1578941,
  // The id of the associated user for the planner override
  "user_id": 1578941,
  // The id of the plannable's associated assignment, if it has one
  "assignment_id": 1578941,
  // The current published state of the item, synced with the associated object
  "workflow_state": "published",
  // Controls whether or not the associated plannable item is marked complete on
  // the planner
  "marked_complete": false,
  // Controls whether or not the associated plannable item shows up in the
  // opportunities list
  "dismissed": false,
  // The datetime of when the planner override was created
  "created_at": "2017-05-09T10:12:00Z",
  // The datetime of when the planner override was updated
  "updated_at": "2017-05-09T10:12:00Z",
  // The datetime of when the planner override was deleted, if applicable
  "deleted_at": "2017-05-15T12:12:00Z"
}

GET /api/v1/planner/items

Scope: url:GET|/api/v1/planner/items

GET /api/v1/users/:user_id/planner/items

Scope: url:GET|/api/v1/users/:user_id/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 user_id and supply the student’s id.

Request Parameters:

Parameter
Type
Description

start_date

Date

Only return items starting from the given date. The value should be formatted as: yyyy-mm-dd or ISO 8601 YYYY-MM-DDTHH:MM:SSZ.

end_date

Date

Only return items up to the given date. The value should be formatted as: yyyy-mm-dd or ISO 8601 YYYY-MM-DDTHH:MM:SSZ.

context_codes[]

string

List of context codes of courses and/or groups whose items you want to see. If not specified, defaults to all contexts associated to the current user. Note that concluded courses will be ignored unless specified in the includes[] parameter. The format of this field is the context type, followed by an underscore, followed by the context id. For example: course_42, group_123

observed_user_id

string

Return planner items for the given observed user. Must be accompanied by context_codes[]. The user making the request must be observing the observed user in all the courses specified by context_codes[].

filter

string

Only return items that have new or unread activity

Allowed values: new_activity

Example Response:

[
 {
   "context_type": "Course",
   "course_id": 1,
   "planner_override": { ... planner override object ... }, // Associated PlannerOverride object if user has toggled visibility for the object on the planner
   "submissions": false, // The statuses of the user's submissions for this object
   "plannable_id": "123",
   "plannable_type": "discussion_topic",
   "plannable": { ... discussion topic object },
   "html_url": "/courses/1/discussion_topics/8"
 },
 {
   "context_type": "Course",
   "course_id": 1,
   "planner_override": {
       "id": 3,
       "plannable_type": "Assignment",
       "plannable_id": 1,
       "user_id": 2,
       "workflow_state": "active",
       "marked_complete": true, // A user-defined setting for marking items complete in the planner
       "dismissed": false, // A user-defined setting for hiding items from the opportunities list
       "deleted_at": null,
       "created_at": "2017-05-18T18:35:55Z",
       "updated_at": "2017-05-18T18:35:55Z"
   },
   "submissions": { // The status as it pertains to the current user
     "excused": false,
     "graded": false,
     "late": false,
     "missing": true,
     "needs_grading": false,
     "with_feedback": false
   },
   "plannable_id": "456",
   "plannable_type": "assignment",
   "plannable": { ... assignment object ...  },
   "html_url": "http://canvas.instructure.com/courses/1/assignments/1#submit"
 },
 {
   "planner_override": null,
   "submissions": false, // false if no associated assignment exists for the plannable item
   "plannable_id": "789",
   "plannable_type": "planner_note",
   "plannable": {
     "id": 1,
     "todo_date": "2017-05-30T06:00:00Z",
     "title": "hello",
     "details": "world",
     "user_id": 2,
     "course_id": null,
     "workflow_state": "active",
     "created_at": "2017-05-30T16:29:04Z",
     "updated_at": "2017-05-30T16:29:15Z"
   },
   "html_url": "http://canvas.instructure.com/api/v1/planner_notes.1"
 }
]

GET /api/v1/planner_notes

Scope: url:GET|/api/v1/planner_notes

Retrieve the paginated list of planner notes

Retrieve planner note for a user

Request Parameters:

Parameter
Type
Description

start_date

DateTime

Only return notes with todo dates since the start_date (inclusive). No default. The value should be formatted as: yyyy-mm-dd or ISO 8601 YYYY-MM-DDTHH:MM:SSZ.

end_date

DateTime

Only return notes with todo dates before the end_date (inclusive). No default. The value should be formatted as: yyyy-mm-dd or ISO 8601 YYYY-MM-DDTHH:MM:SSZ. If end_date and start_date are both specified and equivalent, then only notes with todo dates on that day are returned.

context_codes[]

string

List of context codes of courses whose notes you want to see. If not specified, defaults to all contexts that the user belongs to. The format of this field is the context type, followed by an underscore, followed by the context id. For example: course_42 Including a code matching the user’s own context code (e.g. user_1) will include notes that are not associated with any particular course.

Example Response:

[
  {
    'id': 4,
    'title': 'Bring bio book',
    'description': 'bring bio book for friend tomorrow',
    'user_id': 1238,
    'course_id': 4567,  // If the user assigns a note to a course
    'todo_date': "2017-05-09T10:12:00Z",
    'workflow_state': "active",
  },
  {
    'id': 5,
    'title': 'Bring english book',
    'description': 'bring english book to class tomorrow',
    'user_id': 1234,
    'todo_date': "2017-05-09T10:12:00Z",
    'workflow_state': "active",
  },
]

GET /api/v1/planner_notes/:id

Scope: url:GET|/api/v1/planner_notes/:id

Retrieve a planner note for the current user

PUT /api/v1/planner_notes/:id

Scope: url:PUT|/api/v1/planner_notes/:id

Update a planner note for the current user

Request Parameters:

Parameter
Type
Description

title

string

The title of the planner note.

details

string

Text of the planner note.

todo_date

Date

The date where this planner note should appear in the planner. The value should be formatted as: yyyy-mm-dd.

course_id

integer

The ID of the course to associate with the planner note. The caller must be able to view the course in order to associate it with a planner note. Use a null or empty value to remove a planner note from a course. Note that if the planner note is linked to a learning object, its course_id cannot be changed.

POST /api/v1/planner_notes

Scope: url:POST|/api/v1/planner_notes

Create a planner note for the current user

Request Parameters:

Parameter
Type
Description

title

string

The title of the planner note.

details

string

Text of the planner note.

todo_date

Date

The date where this planner note should appear in the planner. The value should be formatted as: yyyy-mm-dd.

course_id

integer

The ID of the course to associate with the planner note. The caller must be able to view the course in order to associate it with a planner note.

linked_object_type

string

The type of a learning object to link to this planner note. Must be used in conjunction wtih linked_object_id and course_id. Valid linked_object_type values are: ‘announcement’, ‘assignment’, ‘discussion_topic’, ‘wiki_page’, ‘quiz’

linked_object_id

integer

The id of a learning object to link to this planner note. Must be used in conjunction with linked_object_type and course_id. The object must be in the same course as specified by course_id. If the title argument is not provided, the planner note will use the learning object’s title as its title. Only one planner note may be linked to a specific learning object.

DELETE /api/v1/planner_notes/:id

Scope: url:DELETE|/api/v1/planner_notes/:id

Delete a planner note for the current user

GET /api/v1/planner/overrides

Scope: url:GET|/api/v1/planner/overrides

Retrieve a planner override for the current user

GET /api/v1/planner/overrides/:id

Scope: url:GET|/api/v1/planner/overrides/:id

Retrieve a planner override for the current user

PUT /api/v1/planner/overrides/:id

Scope: url:PUT|/api/v1/planner/overrides/:id

Update a planner override’s visibilty for the current user

Request Parameters:

Parameter
Type
Description

marked_complete

string

determines whether the planner item is marked as completed

dismissed

string

determines whether the planner item shows in the opportunities list

POST /api/v1/planner/overrides

Scope: url:POST|/api/v1/planner/overrides

Create a planner override for the current user

Request Parameters:

Parameter
Type
Description

plannable_type

Required string

Type of the item that you are overriding in the planner

Allowed values: announcement, assignment, discussion_topic, quiz, wiki_page, planner_note, calendar_event, assessment_request, sub_assignment

plannable_id

Required integer

ID of the item that you are overriding in the planner

marked_complete

boolean

If this is true, the item will show in the planner as completed

dismissed

boolean

If this is true, the item will not show in the opportunities list

DELETE /api/v1/planner/overrides/:id

Scope: url:DELETE|/api/v1/planner/overrides/:id

Delete a planner override for the current user


PreviousPeer ReviewsNextPoll Sessions

Last updated 1 month ago

Was this helpful?

Returns a list of objects.

Returns a object.

Returns a object.

Returns a object.

Returns a object.

Returns a list of objects.

Returns a object.

Returns a object.

Returns a object.

Returns a object.

This documentation is generated directly from the Canvas LMS source code, available .

PlannerController#index
PlannerNotesController#index
PlannerNotesController#show
PlannerNotesController#update
PlannerNotesController#create
PlannerNotesController#destroy
PlannerOverridesController#index
PlannerOverridesController#show
PlannerOverridesController#update
PlannerOverridesController#create
PlannerOverridesController#destroy
on Github
List planner items
List planner notes
PlannerNote
Show a planner note
PlannerNote
Update a planner note
PlannerNote
Create a planner note
PlannerNote
Delete a planner note
PlannerNote
List planner overrides
PlannerOverride
Show a planner override
PlannerOverride
Update a planner override
PlannerOverride
Create a planner override
PlannerOverride
Delete a planner override
PlannerOverride