> For the complete documentation index, see [llms.txt](https://developerdocs.instructure.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developerdocs.instructure.com/services/canvas/oauth2/file.scopes.md).

# API Scopes

This document lists all available API scopes for Canvas LMS. Scopes control what API endpoints an access token or developer key can access.

## Overview

Canvas has **1087** API scopes organized into **130** resource groups.

## Scope Format

Each scope follows the format: `url:METHOD|/api/path`

For example: `url:GET|/api/v1/courses/:course_id/assignments`

## Scopes by Resource

<details>

<summary><strong>AI Conversations</strong> (9 endpoints)</summary>

| Scope                                                                                                                                  | Description                                                                                                  |
| -------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
| `url:GET\|/api/v1/courses/:course_id/ai_experiences/:ai_experience_id/conversations`                                                   | Get the active conversation for the current user and AI experience                                           |
| `url:POST\|/api/v1/courses/:course_id/ai_experiences/:ai_experience_id/conversations`                                                  | Initialize a new conversation with the AI experience                                                         |
| `url:DELETE\|/api/v1/courses/:course_id/ai_experiences/:ai_experience_id/conversations/:id`                                            | End the current conversation session                                                                         |
| `url:GET\|/api/v1/courses/:course_id/ai_experiences/:ai_experience_id/conversations/:id`                                               | Get a specific conversation by ID (for teachers viewing student conversations)                               |
| `url:GET\|/api/v1/courses/:course_id/ai_experiences/:ai_experience_id/conversations/:id/evaluation`                                    | Fetch the latest stored evaluation for a conversation from the llm-conversation service.                     |
| `url:POST\|/api/v1/courses/:course_id/ai_experiences/:ai_experience_id/conversations/:id/evaluation`                                   | Run the LLM to (re)generate an evaluation for a conversation and persist it in the llm-conversation service. |
| `url:POST\|/api/v1/courses/:course_id/ai_experiences/:ai_experience_id/conversations/:id/messages`                                     | Send a message to an existing conversation and get the AI response                                           |
| `url:POST\|/api/v1/courses/:course_id/ai_experiences/:ai_experience_id/conversations/:id/messages/:message_id/feedback`                | Submit a like or dislike vote on an AI-generated message.                                                    |
| `url:DELETE\|/api/v1/courses/:course_id/ai_experiences/:ai_experience_id/conversations/:id/messages/:message_id/feedback/:feedback_id` | Remove a previously submitted vote (toggling off like/dislike).                                              |

</details>

<details>

<summary><strong>AI Experiences</strong> (9 endpoints)</summary>

| Scope                                                                                      | Description                                                                                |
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
| `url:GET\|/api/v1/courses/:course_id/ai_experiences`                                       | Retrieve the paginated list of AI experiences for a course                                 |
| `url:POST\|/api/v1/courses/:course_id/ai_experiences`                                      | Create a new AI experience for the specified course                                        |
| `url:DELETE\|/api/v1/courses/:course_id/ai_experiences/:id`                                | Delete an AI experience (soft delete - marks as deleted)                                   |
| `url:GET\|/api/v1/courses/:course_id/ai_experiences/:id`                                   | Retrieve an AI experience by ID                                                            |
| `url:PUT\|/api/v1/courses/:course_id/ai_experiences/:id`                                   | Update an existing AI experience                                                           |
| `url:GET\|/api/v1/courses/:course_id/ai_experiences/:id/ai_conversations`                  | Retrieve the latest AI conversation for each student in the course for this AI experience. |
| `url:GET\|/api/v1/courses/:course_id/ai_experiences/:id/ai_conversations/:conversation_id` | Retrieve a specific student's AI conversation with full message history.                   |
| `url:GET\|/api/v1/courses/:course_id/ai_experiences/:id/edit`                              | Display the form for editing an existing AI experience                                     |
| `url:GET\|/api/v1/courses/:course_id/ai_experiences/new`                                   | Display the form for creating a new AI experience                                          |

</details>

<details>

<summary><strong>API Token Scopes</strong> (1 endpoint)</summary>

| Scope                                          | Description                                                               |
| ---------------------------------------------- | ------------------------------------------------------------------------- |
| `url:GET\|/api/v1/accounts/:account_id/scopes` | A list of scopes that can be applied to developer keys and access tokens. |

</details>

<details>

<summary><strong>Access Tokens</strong> (5 endpoints)</summary>

| Scope                                                   | Description                                                                    |
| ------------------------------------------------------- | ------------------------------------------------------------------------------ |
| `url:POST\|/api/v1/users/:user_id/tokens`               | Create a new access token for the specified user.                              |
| `url:DELETE\|/api/v1/users/:user_id/tokens/:id`         | The ID can be the actual database ID of the token, or the 'token\_hint' value. |
| `url:GET\|/api/v1/users/:user_id/tokens/:id`            | The ID can be the actual database ID of the token, or the 'token\_hint' value. |
| `url:PUT\|/api/v1/users/:user_id/tokens/:id`            | Update an existing access token.                                               |
| `url:GET\|/api/v1/users/:user_id/user_generated_tokens` | Returns a list of manually generated access tokens for the specified user.     |

</details>

<details>

<summary><strong>Accessibility Course Scans</strong> (2 endpoints)</summary>

| Scope                                                                 | Description                                                                                                                                                                |
| --------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `url:GET\|/api/v1/users/:user_id/educator_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. |
| `url:POST\|/api/v1/users/:user_id/educator_accessibility_course_scan` | Queues a background job that scans all a11y-enabled courses where the user has an active teacher or designer enrollment.                                                   |

</details>

<details>

<summary><strong>Accessibility Course Statistics</strong> (2 endpoints)</summary>

| Scope                                                                      | Description                                                                                                                                                                                    |
| -------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `url:GET\|/api/v1/users/:user_id/educator_accessibility_course_statistics` | Returns per-course accessibility issue statistics for the current user's active teacher and designer courses.                                                                                  |
| `url:GET\|/api/v1/users/:user_id/educator_accessibility_course_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. |

</details>

<details>

<summary><strong>Account Calendars</strong> (6 endpoints)</summary>

| Scope                                                           | Description                                                                                                 |
| --------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `url:GET\|/api/v1/account_calendars`                            | Returns a paginated list of account calendars available to the current user.                                |
| `url:GET\|/api/v1/account_calendars/:account_id`                | Get details about a specific account calendar.                                                              |
| `url:PUT\|/api/v1/account_calendars/:account_id`                | Set an account calendar's visibility and auto\_subscribe values.                                            |
| `url:GET\|/api/v1/accounts/:account_id/account_calendars`       | Returns a paginated list of account calendars for the provided account and its first level of sub-accounts. |
| `url:PUT\|/api/v1/accounts/:account_id/account_calendars`       | Set visibility and/or auto\_subscribe on many calendars simultaneously.                                     |
| `url:GET\|/api/v1/accounts/:account_id/visible_calendars_count` | Returns the number of visible account calendars.                                                            |

</details>

<details>

<summary><strong>Account Domain Lookups</strong> (1 endpoint)</summary>

| Scope                              | Description                                                                                     |
| ---------------------------------- | ----------------------------------------------------------------------------------------------- |
| `url:GET\|/api/v1/accounts/search` | Returns a list of up to 5 matching account domains Partial match on name / domain are supported |

</details>

<details>

<summary><strong>Account Notifications</strong> (5 endpoints)</summary>

| Scope                                                                | Description                                                                                                                                                                                                     |
| -------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `url:GET\|/api/v1/accounts/:account_id/account_notifications`        | 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 include\_past parameter is passed in as true. |
| `url:POST\|/api/v1/accounts/:account_id/account_notifications`       | Create and return a new global notification for an account.                                                                                                                                                     |
| `url:DELETE\|/api/v1/accounts/:account_id/account_notifications/:id` | If the current user no longer wants to see this account notification, it can be closed with this call.                                                                                                          |
| `url:GET\|/api/v1/accounts/:account_id/account_notifications/:id`    | Returns a global notification for the current user A notification that has been closed by the user will not be returned                                                                                         |
| `url:PUT\|/api/v1/accounts/:account_id/account_notifications/:id`    | Update global notification for an account.                                                                                                                                                                      |

</details>

<details>

<summary><strong>Account Reports</strong> (6 endpoints)</summary>

| Scope                                                             | Description                                                              |
| ----------------------------------------------------------------- | ------------------------------------------------------------------------ |
| `url:GET\|/api/v1/accounts/:account_id/reports`                   | Returns a paginated list of reports for the current context.             |
| `url:GET\|/api/v1/accounts/:account_id/reports/:report`           | Shows all reports that have been run for the account of a specific type. |
| `url:POST\|/api/v1/accounts/:account_id/reports/:report`          | Generates a report instance for the account.                             |
| `url:DELETE\|/api/v1/accounts/:account_id/reports/:report/:id`    | Deletes a generated report instance.                                     |
| `url:GET\|/api/v1/accounts/:account_id/reports/:report/:id`       | Returns the status of a report.                                          |
| `url:PUT\|/api/v1/accounts/:account_id/reports/:report/:id/abort` | Abort a report in progress                                               |

</details>

<details>

<summary><strong>Accounts</strong> (21 endpoints)</summary>

| Scope                                                          | Description                                                                                                               |
| -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |
| `url:GET\|/api/v1/accounts`                                    | A paginated list of accounts that the current user can view or manage.                                                    |
| `url:GET\|/api/v1/accounts/:account_id/courses`                | Retrieve a paginated list of courses in this account.                                                                     |
| `url:GET\|/api/v1/accounts/:account_id/help_links`             | Returns the help links for that account                                                                                   |
| `url:GET\|/api/v1/accounts/:account_id/permissions`            | Returns permission information for the calling user and the given account.                                                |
| `url:GET\|/api/v1/accounts/:account_id/settings`               | Returns a JSON object containing a subset of settings for the specified account.                                          |
| `url:GET\|/api/v1/accounts/:account_id/sub_accounts`           | List accounts that are sub-accounts of the given account.                                                                 |
| `url:POST\|/api/v1/accounts/:account_id/sub_accounts`          | Add a new sub-account to a given account.                                                                                 |
| `url:DELETE\|/api/v1/accounts/:account_id/sub_accounts/:id`    | Cannot delete an account with active courses or active sub\_accounts.                                                     |
| `url:GET\|/api/v1/accounts/:account_id/terms_of_service`       | Returns the terms of service for that account                                                                             |
| `url:DELETE\|/api/v1/accounts/:account_id/users`               | Delete multiple users from a Canvas root account.                                                                         |
| `url:DELETE\|/api/v1/accounts/:account_id/users/:user_id`      | Delete a user record from a Canvas root account.                                                                          |
| `url:PUT\|/api/v1/accounts/:account_id/users/:user_id/restore` | Restore a user record along with the most recently deleted pseudonym from a Canvas root account.                          |
| `url:PUT\|/api/v1/accounts/:account_id/users/bulk_update`      | Updates multiple users in bulk.                                                                                           |
| `url:GET\|/api/v1/accounts/:id`                                | Retrieve information on an individual account, given by id or sis sis\_account\_id.                                       |
| `url:PUT\|/api/v1/accounts/:id`                                | Update an existing account.                                                                                               |
| `url:GET\|/api/v1/course_accounts`                             | A paginated list of accounts that the current user can view through their admin course enrollments.                       |
| `url:GET\|/api/v1/course_creation_accounts`                    | A paginated list of accounts where the current user has permission to create courses.                                     |
| `url:GET\|/api/v1/horizon_accounts`                            | A paginated list of horizon accounts that the current user can view or manage.                                            |
| `url:GET\|/api/v1/manageable_accounts`                         | A paginated list of accounts where the current user has permission to create or manage courses.                           |
| `url:GET\|/api/v1/manually_created_courses_account`            | Returns the sub-account that contains manually created courses for the domain root account.                               |
| `url:GET\|/api/v1/settings/environment`                        | Return a hash of global settings for the root account This is the same information supplied to the web interface as +ENV. |

</details>

<details>

<summary><strong>Admins</strong> (4 endpoints)</summary>

| Scope                                                      | Description                                                          |
| ---------------------------------------------------------- | -------------------------------------------------------------------- |
| `url:GET\|/api/v1/accounts/:account_id/admins`             | A paginated list of the admins in the account                        |
| `url:POST\|/api/v1/accounts/:account_id/admins`            | Flag an existing user as an admin within the account.                |
| `url:DELETE\|/api/v1/accounts/:account_id/admins/:user_id` | Remove the rights associated with an account admin role from a user. |
| `url:GET\|/api/v1/accounts/:account_id/admins/self`        | A paginated list of the current user's roles in the account.         |

</details>

<details>

<summary><strong>Announcement External Feeds</strong> (6 endpoints)</summary>

| Scope                                                                     | Description                                                        |
| ------------------------------------------------------------------------- | ------------------------------------------------------------------ |
| `url:GET\|/api/v1/courses/:course_id/external_feeds`                      | Returns the paginated list of External Feeds this course or group. |
| `url:POST\|/api/v1/courses/:course_id/external_feeds`                     | Create a new external feed for the course or group.                |
| `url:DELETE\|/api/v1/courses/:course_id/external_feeds/:external_feed_id` | Deletes the external feed.                                         |
| `url:GET\|/api/v1/groups/:group_id/external_feeds`                        | Returns the paginated list of External Feeds this course or group. |
| `url:POST\|/api/v1/groups/:group_id/external_feeds`                       | Create a new external feed for the course or group.                |
| `url:DELETE\|/api/v1/groups/:group_id/external_feeds/:external_feed_id`   | Deletes the external feed.                                         |

</details>

<details>

<summary><strong>Announcements</strong> (1 endpoint)</summary>

| Scope                            | Description                                                                       |
| -------------------------------- | --------------------------------------------------------------------------------- |
| `url:GET\|/api/v1/announcements` | Returns the paginated list of announcements for the given courses and date range. |

</details>

<details>

<summary><strong>Appointment Groups</strong> (8 endpoints)</summary>

| Scope                                                  | Description                                                                                            |
| ------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
| `url:GET\|/api/v1/appointment_groups`                  | Retrieve the paginated list of appointment groups that can be reserved or managed by the current user. |
| `url:POST\|/api/v1/appointment_groups`                 | Create and return a new appointment group.                                                             |
| `url:DELETE\|/api/v1/appointment_groups/:id`           | Delete an appointment group (and associated time slots and reservations) and return the deleted group  |
| `url:GET\|/api/v1/appointment_groups/:id`              | Returns information for a single appointment group                                                     |
| `url:PUT\|/api/v1/appointment_groups/:id`              | Update and return an appointment group.                                                                |
| `url:GET\|/api/v1/appointment_groups/:id/groups`       | A paginated list of student groups that are (or may be) participating in this appointment group.       |
| `url:GET\|/api/v1/appointment_groups/:id/users`        | A paginated list of users that are (or may be) participating in this appointment group.                |
| `url:GET\|/api/v1/appointment_groups/next_appointment` | Return the next appointment available to sign up for.                                                  |

</details>

<details>

<summary><strong>Assessment Question Banks</strong> (3 endpoints)</summary>

| Scope                                           | Description                                                       |
| ----------------------------------------------- | ----------------------------------------------------------------- |
| `url:GET\|/api/v1/question_banks`               | Returns the paginated list of question banks for a given context. |
| `url:GET\|/api/v1/question_banks/:id`           | Returns the question bank with the given id                       |
| `url:GET\|/api/v1/question_banks/:id/questions` | Returns the paginated list of assessment questions in this bank.  |

</details>

<details>

<summary><strong>Assignment Extensions</strong> (1 endpoint)</summary>

| Scope                                                                        | Description                                                                                                                                                                                             |
| ---------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `url:POST\|/api/v1/courses/:course_id/assignments/:assignment_id/extensions` | **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 |

</details>

<details>

<summary><strong>Assignment Groups</strong> (5 endpoints)</summary>

| Scope                                                                           | Description                                                              |
| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------ |
| `url:GET\|/api/v1/courses/:course_id/assignment_groups`                         | Returns the paginated list of assignment groups for the current context. |
| `url:POST\|/api/v1/courses/:course_id/assignment_groups`                        | Create a new assignment group for this course.                           |
| `url:DELETE\|/api/v1/courses/:course_id/assignment_groups/:assignment_group_id` | Deletes the assignment group with the given id.                          |
| `url:GET\|/api/v1/courses/:course_id/assignment_groups/:assignment_group_id`    | Returns the assignment group with the given id.                          |
| `url:PUT\|/api/v1/courses/:course_id/assignment_groups/:assignment_group_id`    | Modify an existing Assignment Group.                                     |

</details>

<details>

<summary><strong>Assignment Presets</strong> (10 endpoints)</summary>

| Scope                                                             | Description                                                                 |
| ----------------------------------------------------------------- | --------------------------------------------------------------------------- |
| `url:GET\|/api/v1/accounts/:account_id/assignment_presets`        | Returns the list of assignment presets accessible from the current context. |
| `url:POST\|/api/v1/accounts/:account_id/assignment_presets`       | Create a new assignment preset in the given context.                        |
| `url:DELETE\|/api/v1/accounts/:account_id/assignment_presets/:id` | Soft-deletes an assignment preset.                                          |
| `url:GET\|/api/v1/accounts/:account_id/assignment_presets/:id`    | Returns a single assignment preset.                                         |
| `url:PUT\|/api/v1/accounts/:account_id/assignment_presets/:id`    | Update an existing assignment preset.                                       |
| `url:GET\|/api/v1/courses/:course_id/assignment_presets`          | Returns the list of assignment presets accessible from the current context. |
| `url:POST\|/api/v1/courses/:course_id/assignment_presets`         | Create a new assignment preset in the given context.                        |
| `url:DELETE\|/api/v1/courses/:course_id/assignment_presets/:id`   | Soft-deletes an assignment preset.                                          |
| `url:GET\|/api/v1/courses/:course_id/assignment_presets/:id`      | Returns a single assignment preset.                                         |
| `url:PUT\|/api/v1/courses/:course_id/assignment_presets/:id`      | Update an existing assignment preset.                                       |

</details>

<details>

<summary><strong>Assignments</strong> (20 endpoints)</summary>

| Scope                                                                                         | Description                                                                                                                       |
| --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
| `url:GET\|/api/v1/courses/:course_id/assignment_groups/:assignment_group_id/assignments`      | Returns the paginated list of assignments for the current course or assignment group.                                             |
| `url:GET\|/api/v1/courses/:course_id/assignments`                                             | Returns the paginated list of assignments for the current course or assignment group.                                             |
| `url:POST\|/api/v1/courses/:course_id/assignments`                                            | Create a new assignment for this course.                                                                                          |
| `url:POST\|/api/v1/courses/:course_id/assignments/:assignment_id/duplicate`                   | Duplicate an assignment and return a json based on result\_type argument.                                                         |
| `url:GET\|/api/v1/courses/:course_id/assignments/:assignment_id/overrides`                    | Returns the paginated list of overrides for this assignment that target sections/groups/students visible to the current user.     |
| `url:POST\|/api/v1/courses/:course_id/assignments/:assignment_id/overrides`                   | One of student\_ids, group\_id, or course\_section\_id must be present.                                                           |
| `url:DELETE\|/api/v1/courses/:course_id/assignments/:assignment_id/overrides/:id`             | Deletes an override and returns its former details.                                                                               |
| `url:GET\|/api/v1/courses/:course_id/assignments/:assignment_id/overrides/:id`                | Returns details of the the override with the given id.                                                                            |
| `url:PUT\|/api/v1/courses/:course_id/assignments/:assignment_id/overrides/:id`                | All current overridden values must be supplied if they are to be retained; e.                                                     |
| `url:GET\|/api/v1/courses/:course_id/assignments/:assignment_id/users/:user_id/group_members` | Returns student ids and names for the group.                                                                                      |
| `url:DELETE\|/api/v1/courses/:course_id/assignments/:id`                                      | Delete the given assignment.                                                                                                      |
| `url:GET\|/api/v1/courses/:course_id/assignments/:id`                                         | Returns the assignment with the given id.                                                                                         |
| `url:PUT\|/api/v1/courses/:course_id/assignments/:id`                                         | Modify an existing assignment.                                                                                                    |
| `url:PUT\|/api/v1/courses/:course_id/assignments/bulk_update`                                 | Update due dates and availability dates for multiple assignments in a course.                                                     |
| `url:GET\|/api/v1/courses/:course_id/assignments/overrides`                                   | Returns a list of specified overrides in this course, providing they target sections/groups/students visible to the current user. |
| `url:POST\|/api/v1/courses/:course_id/assignments/overrides`                                  | Creates the specified overrides for each assignment.                                                                              |
| `url:PUT\|/api/v1/courses/:course_id/assignments/overrides`                                   | Updates a list of specified overrides for each assignment.                                                                        |
| `url:GET\|/api/v1/groups/:group_id/assignments/:assignment_id/override`                       | Responds with a redirect to the override for the given group, if any (404 otherwise).                                             |
| `url:GET\|/api/v1/sections/:course_section_id/assignments/:assignment_id/override`            | Responds with a redirect to the override for the given section, if any (404 otherwise).                                           |
| `url:GET\|/api/v1/users/:user_id/courses/:course_id/assignments`                              | Returns the paginated list of assignments for the specified user if the current user has rights to view.                          |

</details>

<details>

<summary><strong>Authentication Providers</strong> (9 endpoints)</summary>

| Scope                                                                                  | Description                                                                                                                                                                                |
| -------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `url:GET\|/api/v1/accounts/:account_id/authentication_providers`                       | Returns a paginated list of authentication providers                                                                                                                                       |
| `url:POST\|/api/v1/accounts/:account_id/authentication_providers`                      | Add external authentication provider(s) for the account.                                                                                                                                   |
| `url:DELETE\|/api/v1/accounts/:account_id/authentication_providers/:id`                | Delete the config                                                                                                                                                                          |
| `url:GET\|/api/v1/accounts/:account_id/authentication_providers/:id`                   | Get the specified authentication provider                                                                                                                                                  |
| `url:PUT\|/api/v1/accounts/:account_id/authentication_providers/:id`                   | Update an authentication provider using the same options as the {api:AuthenticationProvidersController#create Add authentication provider} endpoint.                                       |
| `url:PUT\|/api/v1/accounts/:account_id/authentication_providers/:id/restore`           | Restore an authentication provider back to active that was previously deleted.                                                                                                             |
| `url:POST\|/api/v1/accounts/:account_id/authentication_providers/force_password_reset` | Enqueues a job to set the must\_reset\_password flag on all active Canvas login pseudonyms for the account.                                                                                |
| `url:GET\|/api/v1/accounts/:account_id/sso_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 "update\_sso\_settings" |
| `url:PUT\|/api/v1/accounts/:account_id/sso_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.                                        |

</details>

<details>

<summary><strong>Authentications Log</strong> (3 endpoints)</summary>

| Scope                                                        | Description                                     |
| ------------------------------------------------------------ | ----------------------------------------------- |
| `url:GET\|/api/v1/audit/authentication/accounts/:account_id` | List authentication events for a given account. |
| `url:GET\|/api/v1/audit/authentication/logins/:login_id`     | List authentication events for a given login.   |
| `url:GET\|/api/v1/audit/authentication/users/:user_id`       | List authentication events for a given user.    |

</details>

<details>

<summary><strong>Blackout Dates</strong> (13 endpoints)</summary>

| Scope                                                         | Description                                                                      |
| ------------------------------------------------------------- | -------------------------------------------------------------------------------- |
| `url:GET\|/api/v1/accounts/:account_id/blackout_dates`        | Returns the list of blackout dates for the current context.                      |
| `url:POST\|/api/v1/accounts/:account_id/blackout_dates`       | Create a blackout date for the given context.                                    |
| `url:DELETE\|/api/v1/accounts/:account_id/blackout_dates/:id` | Delete a blackout date for the given context.                                    |
| `url:GET\|/api/v1/accounts/:account_id/blackout_dates/:id`    | Returns the blackout date with the given id.                                     |
| `url:PUT\|/api/v1/accounts/:account_id/blackout_dates/:id`    | Update a blackout date for the given context.                                    |
| `url:GET\|/api/v1/accounts/:account_id/blackout_dates/new`    | Initialize an unsaved Blackout Date for the given context.                       |
| `url:GET\|/api/v1/courses/:course_id/blackout_dates`          | Returns the list of blackout dates for the current context.                      |
| `url:POST\|/api/v1/courses/:course_id/blackout_dates`         | Create a blackout date for the given context.                                    |
| `url:PUT\|/api/v1/courses/:course_id/blackout_dates`          | Create, update, and delete blackout dates to sync the db with the incoming data. |
| `url:DELETE\|/api/v1/courses/:course_id/blackout_dates/:id`   | Delete a blackout date for the given context.                                    |
| `url:GET\|/api/v1/courses/:course_id/blackout_dates/:id`      | Returns the blackout date with the given id.                                     |
| `url:PUT\|/api/v1/courses/:course_id/blackout_dates/:id`      | Update a blackout date for the given context.                                    |
| `url:GET\|/api/v1/courses/:course_id/blackout_dates/new`      | Initialize an unsaved Blackout Date for the given context.                       |

</details>

<details>

<summary><strong>BlockEditorTemplate</strong> (1 endpoint)</summary>

| Scope                                                        | Description                                                  |
| ------------------------------------------------------------ | ------------------------------------------------------------ |
| `url:GET\|/api/v1/courses/:course_id/block_editor_templates` | A list of the block templates available to the current user. |

</details>

<details>

<summary><strong>Blueprint Courses</strong> (13 endpoints)</summary>

| Scope                                                                                                 | Description                                                                                                                         |
| ----------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| `url:GET\|/api/v1/courses/:course_id/blueprint_subscriptions`                                         | Returns a list of blueprint subscriptions for the given course.                                                                     |
| `url:GET\|/api/v1/courses/:course_id/blueprint_subscriptions/:subscription_id/migrations`             | Shows a paginated list of migrations imported into a course associated with a blueprint, starting with the most recent.             |
| `url:GET\|/api/v1/courses/:course_id/blueprint_subscriptions/:subscription_id/migrations/:id`         | Shows the status of an import into a course associated with a blueprint.                                                            |
| `url:GET\|/api/v1/courses/:course_id/blueprint_subscriptions/:subscription_id/migrations/:id/details` | Show the changes that were propagated to a course associated with a blueprint.                                                      |
| `url:GET\|/api/v1/courses/:course_id/blueprint_templates/:template_id`                                | Using 'default' as the template\_id should suffice for the current implmentation (as there should be only one template per course). |
| `url:GET\|/api/v1/courses/:course_id/blueprint_templates/:template_id/associated_courses`             | Returns a list of courses that are configured to receive updates from this blueprint                                                |
| `url:GET\|/api/v1/courses/:course_id/blueprint_templates/:template_id/migrations`                     | Shows a paginated list of migrations for the template, starting with the most recent.                                               |
| `url:POST\|/api/v1/courses/:course_id/blueprint_templates/:template_id/migrations`                    | Begins a migration to push recently updated content to all associated courses.                                                      |
| `url:GET\|/api/v1/courses/:course_id/blueprint_templates/:template_id/migrations/:id`                 | Shows the status of a migration.                                                                                                    |
| `url:GET\|/api/v1/courses/:course_id/blueprint_templates/:template_id/migrations/:id/details`         | Show the changes that were propagated in a blueprint migration.                                                                     |
| `url:PUT\|/api/v1/courses/:course_id/blueprint_templates/:template_id/restrict_item`                  | If a blueprint course object is restricted, editing will be limited for copies in associated courses.                               |
| `url:GET\|/api/v1/courses/:course_id/blueprint_templates/:template_id/unsynced_changes`               | Retrieve a list of learning objects that have changed since the last blueprint sync operation.                                      |
| `url:PUT\|/api/v1/courses/:course_id/blueprint_templates/:template_id/update_associations`            | Send a list of course ids to add or remove new associations for the template.                                                       |

</details>

<details>

<summary><strong>Bookmarks</strong> (5 endpoints)</summary>

| Scope                                          | Description                              |
| ---------------------------------------------- | ---------------------------------------- |
| `url:GET\|/api/v1/users/self/bookmarks`        | Returns the paginated list of bookmarks. |
| `url:POST\|/api/v1/users/self/bookmarks`       | Creates a bookmark.                      |
| `url:DELETE\|/api/v1/users/self/bookmarks/:id` | Deletes a bookmark                       |
| `url:GET\|/api/v1/users/self/bookmarks/:id`    | Returns the details for a bookmark.      |
| `url:PUT\|/api/v1/users/self/bookmarks/:id`    | Updates a bookmark                       |

</details>

<details>

<summary><strong>Brand Configs</strong> (3 endpoints)</summary>

| Scope                                                   | Description                                                                                           |
| ------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| `url:GET\|/api/v1/accounts/:account_id/brand_variables` | Will redirect to a static json file that has all of the brand variables used by the provided context. |
| `url:GET\|/api/v1/brand_variables`                      | Will redirect to a static json file that has all of the brand variables used by this account.         |
| `url:GET\|/api/v1/courses/:course_id/brand_variables`   | Will redirect to a static json file that has all of the brand variables used by the provided context. |

</details>

<details>

<summary><strong>Calendar Events</strong> (12 endpoints)</summary>

| Scope                                                                   | Description                                                                                                                    |
| ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `url:GET\|/api/v1/calendar_events`                                      | Retrieve the paginated list of calendar events or assignments for the current user                                             |
| `url:POST\|/api/v1/calendar_events`                                     | Create and return a new calendar event                                                                                         |
| `url:DELETE\|/api/v1/calendar_events/:id`                               | Delete an event from the calendar and return the deleted event                                                                 |
| `url:GET\|/api/v1/calendar_events/:id`                                  | Returns detailed information about a specific calendar event or assignment.                                                    |
| `url:PUT\|/api/v1/calendar_events/:id`                                  | Update and return a calendar event                                                                                             |
| `url:POST\|/api/v1/calendar_events/:id/reservations`                    | Reserves a particular time slot and return the new reservation                                                                 |
| `url:POST\|/api/v1/calendar_events/:id/reservations/:participant_id`    | Reserves a particular time slot and return the new reservation                                                                 |
| `url:POST\|/api/v1/calendar_events/save_enabled_account_calendars`      | Creates and updates the enabled\_account\_calendars and mark\_feature\_as\_seen user preferences                               |
| `url:GET\|/api/v1/courses/:course_id/calendar_events/timetable`         | Returns the last timetable set by the {api:CalendarEventsApiController#set\_course\_timetable Set a course timetable} endpoint |
| `url:POST\|/api/v1/courses/:course_id/calendar_events/timetable`        | Creates and updates "timetable" events for a course.                                                                           |
| `url:POST\|/api/v1/courses/:course_id/calendar_events/timetable_events` | Creates and updates "timetable" events for a course or course section.                                                         |
| `url:GET\|/api/v1/users/:user_id/calendar_events`                       | Retrieve the paginated list of calendar events or assignments for the specified user.                                          |

</details>

<details>

<summary><strong>Canvas Career Experiences</strong> (4 endpoints)</summary>

| Scope                                        | Description                                                                                      |
| -------------------------------------------- | ------------------------------------------------------------------------------------------------ |
| `url:GET\|/api/v1/career/enabled`            | Returns whether the root account has Canvas Career (Horizon) enabled in at least one subaccount. |
| `url:GET\|/api/v1/career/experience_summary` | Returns the current user's active experience and available experiences they can switch to.       |
| `url:POST\|/api/v1/career/switch_experience` | Switch the current user's active experience to the specified one.                                |
| `url:POST\|/api/v1/career/switch_role`       | Switch the current user's Career role.                                                           |

</details>

<details>

<summary><strong>Canvas Career User Context</strong> (1 endpoint)</summary>

| Scope                                  | Description                                                                                                                                                                           |
| -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `url:GET\|/api/v1/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. |

</details>

<details>

<summary><strong>Collaborations</strong> (5 endpoints)</summary>

| Scope                                                         | Description                                                                                                         |
| ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
| `url:GET\|/api/v1/collaborations/:id/members`                 | A paginated list of the collaborators of a given collaboration                                                      |
| `url:GET\|/api/v1/courses/:course_id/collaborations`          | A paginated list of collaborations the current user has access to in the context of the course provided in the url. |
| `url:GET\|/api/v1/courses/:course_id/potential_collaborators` | A paginated list of the users who can potentially be added to a collaboration in the given context.                 |
| `url:GET\|/api/v1/groups/:group_id/collaborations`            | A paginated list of collaborations the current user has access to in the context of the course provided in the url. |
| `url:GET\|/api/v1/groups/:group_id/potential_collaborators`   | A paginated list of the users who can potentially be added to a collaboration in the given context.                 |

</details>

<details>

<summary><strong>CommMessages</strong> (1 endpoint)</summary>

| Scope                            | Description                                           |
| -------------------------------- | ----------------------------------------------------- |
| `url:GET\|/api/v1/comm_messages` | Retrieve a paginated list of messages sent to a user. |

</details>

<details>

<summary><strong>Communication Channels</strong> (5 endpoints)</summary>

| Scope                                                                      | Description                                                                                    |
| -------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- |
| `url:GET\|/api/v1/users/:user_id/communication_channels`                   | Returns a paginated list of communication channels for the specified user, sorted by position. |
| `url:POST\|/api/v1/users/:user_id/communication_channels`                  | Creates a new communication channel for the specified user.                                    |
| `url:DELETE\|/api/v1/users/:user_id/communication_channels/:id`            | Delete an existing communication channel.                                                      |
| `url:DELETE\|/api/v1/users/:user_id/communication_channels/:type/:address` | Delete an existing communication channel.                                                      |
| `url:DELETE\|/api/v1/users/self/communication_channels/push`               |                                                                                                |

</details>

<details>

<summary><strong>Conferences</strong> (3 endpoints)</summary>

| Scope                                             | Description                                                                                                                                                                         |
| ------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `url:GET\|/api/v1/conferences`                    | 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.                |
| `url:GET\|/api/v1/courses/:course_id/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" |
| `url:GET\|/api/v1/groups/:group_id/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" |

</details>

<details>

<summary><strong>Content Exports</strong> (9 endpoints)</summary>

| Scope                                                     | Description                                                                                |
| --------------------------------------------------------- | ------------------------------------------------------------------------------------------ |
| `url:GET\|/api/v1/courses/:course_id/content_exports`     | A paginated list of the past and pending content export jobs for a course, group, or user. |
| `url:POST\|/api/v1/courses/:course_id/content_exports`    | Begin a content export job for a course, group, or user.                                   |
| `url:GET\|/api/v1/courses/:course_id/content_exports/:id` | Get information about a single content export.                                             |
| `url:GET\|/api/v1/groups/:group_id/content_exports`       | A paginated list of the past and pending content export jobs for a course, group, or user. |
| `url:POST\|/api/v1/groups/:group_id/content_exports`      | Begin a content export job for a course, group, or user.                                   |
| `url:GET\|/api/v1/groups/:group_id/content_exports/:id`   | Get information about a single content export.                                             |
| `url:GET\|/api/v1/users/:user_id/content_exports`         | A paginated list of the past and pending content export jobs for a course, group, or user. |
| `url:POST\|/api/v1/users/:user_id/content_exports`        | Begin a content export job for a course, group, or user.                                   |
| `url:GET\|/api/v1/users/:user_id/content_exports/:id`     | Get information about a single content export.                                             |

</details>

<details>

<summary><strong>Content Migrations</strong> (37 endpoints)</summary>

| Scope                                                                                                 | Description                                                                                                                                                                                                                                                                       |
| ----------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `url:GET\|/api/v1/accounts/:account_id/content_migrations`                                            | Returns paginated content migrations                                                                                                                                                                                                                                              |
| `url:POST\|/api/v1/accounts/:account_id/content_migrations`                                           | Create a content migration.                                                                                                                                                                                                                                                       |
| `url:GET\|/api/v1/accounts/:account_id/content_migrations/:content_migration_id/migration_issues`     | Returns paginated migration issues                                                                                                                                                                                                                                                |
| `url:GET\|/api/v1/accounts/:account_id/content_migrations/:content_migration_id/migration_issues/:id` | Returns data on an individual migration issue                                                                                                                                                                                                                                     |
| `url:PUT\|/api/v1/accounts/:account_id/content_migrations/:content_migration_id/migration_issues/:id` | Update the workflow\_state of a migration issue                                                                                                                                                                                                                                   |
| `url:GET\|/api/v1/accounts/:account_id/content_migrations/:id`                                        | Returns data on an individual content migration                                                                                                                                                                                                                                   |
| `url:PUT\|/api/v1/accounts/:account_id/content_migrations/:id`                                        | Update a content migration.                                                                                                                                                                                                                                                       |
| `url:GET\|/api/v1/accounts/:account_id/content_migrations/:id/selective_data`                         | Enumerates the content available for selective import in a tree structure.                                                                                                                                                                                                        |
| `url:GET\|/api/v1/accounts/:account_id/content_migrations/migrators`                                  | Lists the currently available migration types.                                                                                                                                                                                                                                    |
| `url:GET\|/api/v1/courses/:course_id/content_migrations`                                              | Returns paginated content migrations                                                                                                                                                                                                                                              |
| `url:POST\|/api/v1/courses/:course_id/content_migrations`                                             | Create a content migration.                                                                                                                                                                                                                                                       |
| `url:GET\|/api/v1/courses/:course_id/content_migrations/:content_migration_id/migration_issues`       | Returns paginated migration issues                                                                                                                                                                                                                                                |
| `url:GET\|/api/v1/courses/:course_id/content_migrations/:content_migration_id/migration_issues/:id`   | Returns data on an individual migration issue                                                                                                                                                                                                                                     |
| `url:PUT\|/api/v1/courses/:course_id/content_migrations/:content_migration_id/migration_issues/:id`   | Update the workflow\_state of a migration issue                                                                                                                                                                                                                                   |
| `url:GET\|/api/v1/courses/:course_id/content_migrations/:id`                                          | Returns data on an individual content migration                                                                                                                                                                                                                                   |
| `url:PUT\|/api/v1/courses/:course_id/content_migrations/:id`                                          | Update a content migration.                                                                                                                                                                                                                                                       |
| `url:GET\|/api/v1/courses/:course_id/content_migrations/:id/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 migration\_type (course copy or blueprint). |
| `url:GET\|/api/v1/courses/:course_id/content_migrations/:id/selective_data`                           | Enumerates the content available for selective import in a tree structure.                                                                                                                                                                                                        |
| `url:GET\|/api/v1/courses/:course_id/content_migrations/migrators`                                    | Lists the currently available migration types.                                                                                                                                                                                                                                    |
| `url:GET\|/api/v1/groups/:group_id/content_migrations`                                                | Returns paginated content migrations                                                                                                                                                                                                                                              |
| `url:POST\|/api/v1/groups/:group_id/content_migrations`                                               | Create a content migration.                                                                                                                                                                                                                                                       |
| `url:GET\|/api/v1/groups/:group_id/content_migrations/:content_migration_id/migration_issues`         | Returns paginated migration issues                                                                                                                                                                                                                                                |
| `url:GET\|/api/v1/groups/:group_id/content_migrations/:content_migration_id/migration_issues/:id`     | Returns data on an individual migration issue                                                                                                                                                                                                                                     |
| `url:PUT\|/api/v1/groups/:group_id/content_migrations/:content_migration_id/migration_issues/:id`     | Update the workflow\_state of a migration issue                                                                                                                                                                                                                                   |
| `url:GET\|/api/v1/groups/:group_id/content_migrations/:id`                                            | Returns data on an individual content migration                                                                                                                                                                                                                                   |
| `url:PUT\|/api/v1/groups/:group_id/content_migrations/:id`                                            | Update a content migration.                                                                                                                                                                                                                                                       |
| `url:GET\|/api/v1/groups/:group_id/content_migrations/:id/selective_data`                             | Enumerates the content available for selective import in a tree structure.                                                                                                                                                                                                        |
| `url:GET\|/api/v1/groups/:group_id/content_migrations/migrators`                                      | Lists the currently available migration types.                                                                                                                                                                                                                                    |
| `url:GET\|/api/v1/users/:user_id/content_migrations`                                                  | Returns paginated content migrations                                                                                                                                                                                                                                              |
| `url:POST\|/api/v1/users/:user_id/content_migrations`                                                 | Create a content migration.                                                                                                                                                                                                                                                       |
| `url:GET\|/api/v1/users/:user_id/content_migrations/:content_migration_id/migration_issues`           | Returns paginated migration issues                                                                                                                                                                                                                                                |
| `url:GET\|/api/v1/users/:user_id/content_migrations/:content_migration_id/migration_issues/:id`       | Returns data on an individual migration issue                                                                                                                                                                                                                                     |
| `url:PUT\|/api/v1/users/:user_id/content_migrations/:content_migration_id/migration_issues/:id`       | Update the workflow\_state of a migration issue                                                                                                                                                                                                                                   |
| `url:GET\|/api/v1/users/:user_id/content_migrations/:id`                                              | Returns data on an individual content migration                                                                                                                                                                                                                                   |
| `url:PUT\|/api/v1/users/:user_id/content_migrations/:id`                                              | Update a content migration.                                                                                                                                                                                                                                                       |
| `url:GET\|/api/v1/users/:user_id/content_migrations/:id/selective_data`                               | Enumerates the content available for selective import in a tree structure.                                                                                                                                                                                                        |
| `url:GET\|/api/v1/users/:user_id/content_migrations/migrators`                                        | Lists the currently available migration types.                                                                                                                                                                                                                                    |

</details>

<details>

<summary><strong>Content Security Policy Settings</strong> (8 endpoints)</summary>

| Scope                                                                      | Description                                                                                                                                                                                                                                                                        |
| -------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `url:GET\|/api/v1/accounts/:account_id/csp_settings`                       | Update multiple modules in an account.                                                                                                                                                                                                                                             |
| `url:PUT\|/api/v1/accounts/:account_id/csp_settings`                       | 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 "settings\_locked" are both true for this account or course, then the CSP setting cannot be modified. |
| `url:DELETE\|/api/v1/accounts/:account_id/csp_settings/domains`            | Removes an allowed domain from the current account.                                                                                                                                                                                                                                |
| `url:POST\|/api/v1/accounts/:account_id/csp_settings/domains`              | Adds an allowed domain for the current account.                                                                                                                                                                                                                                    |
| `url:POST\|/api/v1/accounts/:account_id/csp_settings/domains/batch_create` | Adds multiple allowed domains for the current account.                                                                                                                                                                                                                             |
| `url:PUT\|/api/v1/accounts/:account_id/csp_settings/lock`                  | Can only be set if CSP is explicitly enabled or disabled on this account (i.                                                                                                                                                                                                       |
| `url:GET\|/api/v1/courses/:course_id/csp_settings`                         | Update multiple modules in an account.                                                                                                                                                                                                                                             |
| `url:PUT\|/api/v1/courses/:course_id/csp_settings`                         | 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 "settings\_locked" are both true for this account or course, then the CSP setting cannot be modified. |

</details>

<details>

<summary><strong>Content Shares</strong> (8 endpoints)</summary>

| Scope                                                           | Description                                                                          |
| --------------------------------------------------------------- | ------------------------------------------------------------------------------------ |
| `url:POST\|/api/v1/users/:user_id/content_shares`               | Share content directly between two or more users                                     |
| `url:DELETE\|/api/v1/users/:user_id/content_shares/:id`         | Remove a content share from your list.                                               |
| `url:GET\|/api/v1/users/:user_id/content_shares/:id`            | Return information about a single content share.                                     |
| `url:PUT\|/api/v1/users/:user_id/content_shares/:id`            | Mark a content share read or unread                                                  |
| `url:POST\|/api/v1/users/:user_id/content_shares/:id/add_users` | Send a previously created content share to additional users                          |
| `url:GET\|/api/v1/users/:user_id/content_shares/received`       | Return a paginated list of content shares a user has sent or received.               |
| `url:GET\|/api/v1/users/:user_id/content_shares/sent`           | Return a paginated list of content shares a user has sent or received.               |
| `url:GET\|/api/v1/users/:user_id/content_shares/unread_count`   | Return the number of content shares a user has received that have not yet been read. |

</details>

<details>

<summary><strong>Conversations</strong> (12 endpoints)</summary>

| Scope                                                 | Description                                                                               |
| ----------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| `url:GET\|/api/v1/conversations`                      | Returns the paginated list of conversations for the current user, most recent ones first. |
| `url:POST\|/api/v1/conversations`                     | Create a new conversation with one or more recipients.                                    |
| `url:PUT\|/api/v1/conversations`                      | Perform a change on a set of conversations.                                               |
| `url:DELETE\|/api/v1/conversations/:id`               | Delete this conversation and its messages.                                                |
| `url:GET\|/api/v1/conversations/:id`                  | Returns information for a single conversation for the current user.                       |
| `url:PUT\|/api/v1/conversations/:id`                  | Updates attributes for a single conversation.                                             |
| `url:POST\|/api/v1/conversations/:id/add_message`     | Add a message to an existing conversation.                                                |
| `url:POST\|/api/v1/conversations/:id/add_recipients`  | Add recipients to an existing group conversation.                                         |
| `url:POST\|/api/v1/conversations/:id/remove_messages` | Delete messages from this conversation.                                                   |
| `url:GET\|/api/v1/conversations/batches`              | Returns any currently running conversation batches for the current user.                  |
| `url:POST\|/api/v1/conversations/mark_all_as_read`    | Mark all conversations as read.                                                           |
| `url:GET\|/api/v1/conversations/unread_count`         | Get the number of unread conversations for the current user                               |

</details>

<details>

<summary><strong>Course Audit log</strong> (2 endpoints)</summary>

| Scope                                                | Description                                    |
| ---------------------------------------------------- | ---------------------------------------------- |
| `url:GET\|/api/v1/audit/course/accounts/:account_id` | List course change events for a given account. |
| `url:GET\|/api/v1/audit/course/courses/:course_id`   | List course change events for a given course.  |

</details>

<details>

<summary><strong>Course Pace</strong> (4 endpoints)</summary>

| Scope                                                      | Description                                               |
| ---------------------------------------------------------- | --------------------------------------------------------- |
| `url:POST\|/api/v1/courses/:course_id/course_pacing`       | Creates a new course pace with specified parameters.      |
| `url:DELETE\|/api/v1/courses/:course_id/course_pacing/:id` | Returns the updated course pace                           |
| `url:GET\|/api/v1/courses/:course_id/course_pacing/:id`    | Returns a course pace for the course and pace id provided |
| `url:PUT\|/api/v1/courses/:course_id/course_pacing/:id`    | Returns the updated course pace                           |

</details>

<details>

<summary><strong>Course Quiz Extensions</strong> (1 endpoint)</summary>

| Scope                                                  | Description                                                                                                                             |
| ------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------- |
| `url:POST\|/api/v1/courses/:course_id/quiz_extensions` | **Responses** \* **200 OK** if the request was successful \* **403 Forbidden** if you are not allowed to extend quizzes for this course |

</details>

<details>

<summary><strong>Course Reports</strong> (3 endpoints)</summary>

| Scope                                                          | Description                                                          |
| -------------------------------------------------------------- | -------------------------------------------------------------------- |
| `url:GET\|/api/v1/courses/:course_id/reports/:report_type`     | Returns the status of the last report initiated by the current user. |
| `url:POST\|/api/v1/courses/:course_id/reports/:report_type`    | Generates a report instance for the account.                         |
| `url:GET\|/api/v1/courses/:course_id/reports/:report_type/:id` | Returns the status of a report.                                      |

</details>

<details>

<summary><strong>Courses</strong> (31 endpoints)</summary>

| Scope                                                                | Description                                                                                                                                 |
| -------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| `url:POST\|/api/v1/accounts/:account_id/courses`                     | Create a new course                                                                                                                         |
| `url:PUT\|/api/v1/accounts/:account_id/courses`                      | Update multiple courses in an account.                                                                                                      |
| `url:GET\|/api/v1/accounts/:account_id/courses/:id`                  | Return information on a single course.                                                                                                      |
| `url:GET\|/api/v1/courses`                                           | Shows the user's courses                                                                                                                    |
| `url:GET\|/api/v1/courses/:course_id/activity_stream`                | Returns the current user's course-specific activity stream, paginated.                                                                      |
| `url:GET\|/api/v1/courses/:course_id/activity_stream/summary`        | Returns a summary of the current user's course-specific activity stream.                                                                    |
| `url:GET\|/api/v1/courses/:course_id/bulk_user_progress`             | Returns progress information for all users enrolled in the given course.                                                                    |
| `url:GET\|/api/v1/courses/:course_id/content_share_users`            | Returns a paginated list of users you can share content with.                                                                               |
| `url:POST\|/api/v1/courses/:course_id/course_copy`                   | DEPRECATED: Please use the {api:ContentMigrationsController#create Content Migrations API} Copies content from one course into another.     |
| `url:GET\|/api/v1/courses/:course_id/course_copy/:id`                | DEPRECATED: Please use the {api:ContentMigrationsController#create Content Migrations API} Retrieve the status of a course copy             |
| `url:GET\|/api/v1/courses/:course_id/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. |
| `url:POST\|/api/v1/courses/:course_id/files`                         | Upload a file to the course.                                                                                                                |
| `url:GET\|/api/v1/courses/:course_id/permissions`                    | Returns permission information for the calling user in the given course.                                                                    |
| `url:POST\|/api/v1/courses/:course_id/preview_html`                  | Preview html content processed for this course                                                                                              |
| `url:GET\|/api/v1/courses/:course_id/recent_students`                | Returns the paginated list of users in this course, ordered by how recently they have logged in.                                            |
| `url:POST\|/api/v1/courses/:course_id/reset_content`                 | Deletes the current course, and creates a new equivalent course with no content, but all sections and users moved over.                     |
| `url:POST\|/api/v1/courses/:course_id/restore/:version_id`           | Restore a course's syllabus body to a previously saved version.                                                                             |
| `url:GET\|/api/v1/courses/:course_id/search_users`                   | Returns the paginated list of users in this course.                                                                                         |
| `url:GET\|/api/v1/courses/:course_id/settings`                       | Returns some of a course's settings.                                                                                                        |
| `url:PUT\|/api/v1/courses/:course_id/settings`                       | Can update the following course settings:                                                                                                   |
| `url:GET\|/api/v1/courses/:course_id/student_view_student`           | Returns information for a test student in this course.                                                                                      |
| `url:GET\|/api/v1/courses/:course_id/students`                       | Returns the paginated list of students enrolled in this course.                                                                             |
| `url:GET\|/api/v1/courses/:course_id/todo`                           | Returns the current user's course-specific todo items.                                                                                      |
| `url:GET\|/api/v1/courses/:course_id/users`                          | Returns the paginated list of users in this course.                                                                                         |
| `url:GET\|/api/v1/courses/:course_id/users/:id`                      | Return information on a single user.                                                                                                        |
| `url:GET\|/api/v1/courses/:course_id/users/:user_id/progress`        | Return progress information for the user and course You can supply +self+ as the user\_id to query your own progress in a course.           |
| `url:DELETE\|/api/v1/courses/:id`                                    | Delete or conclude an existing course                                                                                                       |
| `url:GET\|/api/v1/courses/:id`                                       | Return information on a single course.                                                                                                      |
| `url:PUT\|/api/v1/courses/:id`                                       | Update an existing course.                                                                                                                  |
| `url:POST\|/api/v1/courses/:id/dismiss_migration_limitation_message` | 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    |
| `url:GET\|/api/v1/users/:user_id/courses`                            | Returns a paginated list of active courses for this user.                                                                                   |

</details>

<details>

<summary><strong>Custom Gradebook Columns</strong> (8 endpoints)</summary>

| Scope                                                                            | Description                                                                                                                                                                                                                                                          |
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `url:PUT\|/api/v1/courses/:course_id/custom_gradebook_column_data`               | Set the content of custom columns { "column\_data": \[ { "column\_id": example\_column\_id, "user\_id": example\_student\_id, "content": example\_content }, { "column\_id": example\_column\_id, "user\_id": example\_student\_id, "content: example\_content } ] } |
| `url:GET\|/api/v1/courses/:course_id/custom_gradebook_columns`                   | A paginated list of all custom gradebook columns for a course                                                                                                                                                                                                        |
| `url:POST\|/api/v1/courses/:course_id/custom_gradebook_columns`                  | Create a custom gradebook column                                                                                                                                                                                                                                     |
| `url:DELETE\|/api/v1/courses/:course_id/custom_gradebook_columns/:id`            | Permanently deletes a custom column and its associated data                                                                                                                                                                                                          |
| `url:PUT\|/api/v1/courses/:course_id/custom_gradebook_columns/:id`               | Accepts the same parameters as custom gradebook column creation                                                                                                                                                                                                      |
| `url:GET\|/api/v1/courses/:course_id/custom_gradebook_columns/:id/data`          | This does not list entries for students without associated data.                                                                                                                                                                                                     |
| `url:PUT\|/api/v1/courses/:course_id/custom_gradebook_columns/:id/data/:user_id` | Set the content of a custom column                                                                                                                                                                                                                                   |
| `url:POST\|/api/v1/courses/:course_id/custom_gradebook_columns/reorder`          | Puts the given columns in the specified order **200 OK** is returned if successful                                                                                                                                                                                   |

</details>

<details>

<summary><strong>Developer Key Account Bindings</strong> (1 endpoint)</summary>

| Scope                                                                                                    | Description                                 |
| -------------------------------------------------------------------------------------------------------- | ------------------------------------------- |
| `url:POST\|/api/v1/accounts/:account_id/developer_keys/:developer_key_id/developer_key_account_bindings` | Create a new Developer Key Account Binding. |

</details>

<details>

<summary><strong>Developer Keys</strong> (5 endpoints)</summary>

| Scope                                                    | Description                                                      |
| -------------------------------------------------------- | ---------------------------------------------------------------- |
| `url:GET\|/api/v1/accounts/:account_id/developer_keys`   | List all developer keys created in the current account.          |
| `url:POST\|/api/v1/accounts/:account_id/developer_keys`  | Create a new Canvas API key.                                     |
| `url:DELETE\|/api/v1/developer_keys/:id`                 | Delete an existing Canvas API key.                               |
| `url:PUT\|/api/v1/developer_keys/:id`                    | Update an existing Canvas API key.                               |
| `url:POST\|/api/v1/developer_keys/:id/regenerate_secret` | Regenerate the secret (api\_key) for an existing Canvas API key. |

</details>

<details>

<summary><strong>Discovery Pages</strong> (3 endpoints)</summary>

| Scope                                     | Description                                                                                                                                                                  |
| ----------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `url:GET\|/api/v1/discovery_pages`        | Get the discovery page configuration for the domain root account.                                                                                                            |
| `url:PUT\|/api/v1/discovery_pages`        | Update or create the discovery page configuration for the domain root account.                                                                                               |
| `url:POST\|/api/v1/discovery_pages/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. |

</details>

<details>

<summary><strong>Discussion Topics</strong> (58 endpoints)</summary>

| Scope                                                                                             | Description                                                                                                                                                                                                                                      |
| ------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `url:GET\|/api/v1/courses/:course_id/discussion_topics`                                           | Returns the paginated list of discussion topics for this course or group.                                                                                                                                                                        |
| `url:POST\|/api/v1/courses/:course_id/discussion_topics`                                          | Create an new discussion topic for the course or group.                                                                                                                                                                                          |
| `url:DELETE\|/api/v1/courses/:course_id/discussion_topics/:topic_id`                              | Deletes the discussion topic.                                                                                                                                                                                                                    |
| `url:GET\|/api/v1/courses/:course_id/discussion_topics/:topic_id`                                 | Returns data on an individual discussion topic.                                                                                                                                                                                                  |
| `url:PUT\|/api/v1/courses/:course_id/discussion_topics/:topic_id`                                 | Update an existing discussion topic for the course or group.                                                                                                                                                                                     |
| `url:POST\|/api/v1/courses/:course_id/discussion_topics/:topic_id/duplicate`                      | Duplicate a discussion topic according to context (Course/Group)                                                                                                                                                                                 |
| `url:GET\|/api/v1/courses/:course_id/discussion_topics/:topic_id/entries`                         | Retrieve the (paginated) top-level entries in a discussion topic.                                                                                                                                                                                |
| `url:POST\|/api/v1/courses/:course_id/discussion_topics/:topic_id/entries`                        | Create a new entry in a discussion topic.                                                                                                                                                                                                        |
| `url:POST\|/api/v1/courses/:course_id/discussion_topics/:topic_id/entries/:entry_id/rating`       | Rate a discussion entry.                                                                                                                                                                                                                         |
| `url:DELETE\|/api/v1/courses/:course_id/discussion_topics/:topic_id/entries/:entry_id/read`       | Mark a discussion entry as unread.                                                                                                                                                                                                               |
| `url:PUT\|/api/v1/courses/:course_id/discussion_topics/:topic_id/entries/:entry_id/read`          | Mark a discussion entry as read.                                                                                                                                                                                                                 |
| `url:GET\|/api/v1/courses/:course_id/discussion_topics/:topic_id/entries/:entry_id/replies`       | Retrieve the (paginated) replies to a top-level entry in a discussion topic.                                                                                                                                                                     |
| `url:POST\|/api/v1/courses/:course_id/discussion_topics/:topic_id/entries/:entry_id/replies`      | Add a reply to an entry in a discussion topic.                                                                                                                                                                                                   |
| `url:DELETE\|/api/v1/courses/:course_id/discussion_topics/:topic_id/entries/:id`                  | Delete a discussion entry.                                                                                                                                                                                                                       |
| `url:PUT\|/api/v1/courses/:course_id/discussion_topics/:topic_id/entries/:id`                     | Update an existing discussion entry.                                                                                                                                                                                                             |
| `url:GET\|/api/v1/courses/:course_id/discussion_topics/:topic_id/entry_list`                      | Retrieve a paginated list of discussion entries, given a list of ids.                                                                                                                                                                            |
| `url:DELETE\|/api/v1/courses/:course_id/discussion_topics/:topic_id/read`                         | Mark the initial text of the discussion topic as unread.                                                                                                                                                                                         |
| `url:PUT\|/api/v1/courses/:course_id/discussion_topics/:topic_id/read`                            | Mark the initial text of the discussion topic as read.                                                                                                                                                                                           |
| `url:DELETE\|/api/v1/courses/:course_id/discussion_topics/:topic_id/read_all`                     | Mark the discussion topic and all its entries as unread.                                                                                                                                                                                         |
| `url:PUT\|/api/v1/courses/:course_id/discussion_topics/:topic_id/read_all`                        | Mark the discussion topic and all its entries as read.                                                                                                                                                                                           |
| `url:DELETE\|/api/v1/courses/:course_id/discussion_topics/:topic_id/subscribed`                   | Unsubscribe from a topic to stop receiving notifications about new entries On success, the response will be 204 No Content with an empty body                                                                                                    |
| `url:PUT\|/api/v1/courses/:course_id/discussion_topics/:topic_id/subscribed`                      | Subscribe to a topic to receive notifications about new entries On success, the response will be 204 No Content with an empty body                                                                                                               |
| `url:GET\|/api/v1/courses/:course_id/discussion_topics/:topic_id/summaries`                       | 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. |
| `url:POST\|/api/v1/courses/:course_id/discussion_topics/:topic_id/summaries`                      | Generates a summary for a discussion topic.                                                                                                                                                                                                      |
| `url:POST\|/api/v1/courses/:course_id/discussion_topics/:topic_id/summaries/:summary_id/feedback` | Persists feedback on a discussion topic summary.                                                                                                                                                                                                 |
| `url:PUT\|/api/v1/courses/:course_id/discussion_topics/:topic_id/summaries/disable`               | Deprecated, to remove after VICE-5047 gets merged Disables the summary for a discussion topic.                                                                                                                                                   |
| `url:GET\|/api/v1/courses/:course_id/discussion_topics/:topic_id/view`                            | Return a cached structure of the discussion topic, containing all entries, their authors, and their message bodies.                                                                                                                              |
| `url:PUT\|/api/v1/courses/:course_id/discussion_topics/read_all`                                  | Mark the initial text of all the discussion topics as read in the context.                                                                                                                                                                       |
| `url:POST\|/api/v1/courses/:course_id/discussion_topics/reorder`                                  | Puts the pinned discussion topics in the specified order.                                                                                                                                                                                        |
| `url:GET\|/api/v1/groups/:group_id/discussion_topics`                                             | Returns the paginated list of discussion topics for this course or group.                                                                                                                                                                        |
| `url:POST\|/api/v1/groups/:group_id/discussion_topics`                                            | Create an new discussion topic for the course or group.                                                                                                                                                                                          |
| `url:DELETE\|/api/v1/groups/:group_id/discussion_topics/:topic_id`                                | Deletes the discussion topic.                                                                                                                                                                                                                    |
| `url:GET\|/api/v1/groups/:group_id/discussion_topics/:topic_id`                                   | Returns data on an individual discussion topic.                                                                                                                                                                                                  |
| `url:PUT\|/api/v1/groups/:group_id/discussion_topics/:topic_id`                                   | Update an existing discussion topic for the course or group.                                                                                                                                                                                     |
| `url:POST\|/api/v1/groups/:group_id/discussion_topics/:topic_id/duplicate`                        | Duplicate a discussion topic according to context (Course/Group)                                                                                                                                                                                 |
| `url:GET\|/api/v1/groups/:group_id/discussion_topics/:topic_id/entries`                           | Retrieve the (paginated) top-level entries in a discussion topic.                                                                                                                                                                                |
| `url:POST\|/api/v1/groups/:group_id/discussion_topics/:topic_id/entries`                          | Create a new entry in a discussion topic.                                                                                                                                                                                                        |
| `url:POST\|/api/v1/groups/:group_id/discussion_topics/:topic_id/entries/:entry_id/rating`         | Rate a discussion entry.                                                                                                                                                                                                                         |
| `url:DELETE\|/api/v1/groups/:group_id/discussion_topics/:topic_id/entries/:entry_id/read`         | Mark a discussion entry as unread.                                                                                                                                                                                                               |
| `url:PUT\|/api/v1/groups/:group_id/discussion_topics/:topic_id/entries/:entry_id/read`            | Mark a discussion entry as read.                                                                                                                                                                                                                 |
| `url:GET\|/api/v1/groups/:group_id/discussion_topics/:topic_id/entries/:entry_id/replies`         | Retrieve the (paginated) replies to a top-level entry in a discussion topic.                                                                                                                                                                     |
| `url:POST\|/api/v1/groups/:group_id/discussion_topics/:topic_id/entries/:entry_id/replies`        | Add a reply to an entry in a discussion topic.                                                                                                                                                                                                   |
| `url:DELETE\|/api/v1/groups/:group_id/discussion_topics/:topic_id/entries/:id`                    | Delete a discussion entry.                                                                                                                                                                                                                       |
| `url:PUT\|/api/v1/groups/:group_id/discussion_topics/:topic_id/entries/:id`                       | Update an existing discussion entry.                                                                                                                                                                                                             |
| `url:GET\|/api/v1/groups/:group_id/discussion_topics/:topic_id/entry_list`                        | Retrieve a paginated list of discussion entries, given a list of ids.                                                                                                                                                                            |
| `url:DELETE\|/api/v1/groups/:group_id/discussion_topics/:topic_id/read`                           | Mark the initial text of the discussion topic as unread.                                                                                                                                                                                         |
| `url:PUT\|/api/v1/groups/:group_id/discussion_topics/:topic_id/read`                              | Mark the initial text of the discussion topic as read.                                                                                                                                                                                           |
| `url:DELETE\|/api/v1/groups/:group_id/discussion_topics/:topic_id/read_all`                       | Mark the discussion topic and all its entries as unread.                                                                                                                                                                                         |
| `url:PUT\|/api/v1/groups/:group_id/discussion_topics/:topic_id/read_all`                          | Mark the discussion topic and all its entries as read.                                                                                                                                                                                           |
| `url:DELETE\|/api/v1/groups/:group_id/discussion_topics/:topic_id/subscribed`                     | Unsubscribe from a topic to stop receiving notifications about new entries On success, the response will be 204 No Content with an empty body                                                                                                    |
| `url:PUT\|/api/v1/groups/:group_id/discussion_topics/:topic_id/subscribed`                        | Subscribe to a topic to receive notifications about new entries On success, the response will be 204 No Content with an empty body                                                                                                               |
| `url:GET\|/api/v1/groups/:group_id/discussion_topics/:topic_id/summaries`                         | 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. |
| `url:POST\|/api/v1/groups/:group_id/discussion_topics/:topic_id/summaries`                        | Generates a summary for a discussion topic.                                                                                                                                                                                                      |
| `url:POST\|/api/v1/groups/:group_id/discussion_topics/:topic_id/summaries/:summary_id/feedback`   | Persists feedback on a discussion topic summary.                                                                                                                                                                                                 |
| `url:PUT\|/api/v1/groups/:group_id/discussion_topics/:topic_id/summaries/disable`                 | Deprecated, to remove after VICE-5047 gets merged Disables the summary for a discussion topic.                                                                                                                                                   |
| `url:GET\|/api/v1/groups/:group_id/discussion_topics/:topic_id/view`                              | Return a cached structure of the discussion topic, containing all entries, their authors, and their message bodies.                                                                                                                              |
| `url:PUT\|/api/v1/groups/:group_id/discussion_topics/read_all`                                    | Mark the initial text of all the discussion topics as read in the context.                                                                                                                                                                       |
| `url:POST\|/api/v1/groups/:group_id/discussion_topics/reorder`                                    | Puts the pinned discussion topics in the specified order.                                                                                                                                                                                        |

</details>

<details>

<summary><strong>Enrollment Terms</strong> (5 endpoints)</summary>

| Scope                                                | Description                                                         |
| ---------------------------------------------------- | ------------------------------------------------------------------- |
| `url:GET\|/api/v1/accounts/:account_id/terms`        | An object with a paginated list of all of the terms in the account. |
| `url:POST\|/api/v1/accounts/:account_id/terms`       | Create a new enrollment term for the specified account.             |
| `url:DELETE\|/api/v1/accounts/:account_id/terms/:id` | Delete the specified enrollment term.                               |
| `url:GET\|/api/v1/accounts/:account_id/terms/:id`    | Retrieves the details for an enrollment term in the account.        |
| `url:PUT\|/api/v1/accounts/:account_id/terms/:id`    | Update an existing enrollment term for the specified account.       |

</details>

<details>

<summary><strong>Enrollments</strong> (14 endpoints)</summary>

| Scope                                                              | Description                                                                                                                                                                       |
| ------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `url:POST\|/api/v1/accounts/:account_id/bulk_enrollment`           | Enrolls multiple users in one or more courses in a single operation.                                                                                                              |
| `url:GET\|/api/v1/accounts/:account_id/enrollments/:id`            | Get an Enrollment object by Enrollment ID                                                                                                                                         |
| `url:GET\|/api/v1/courses/:course_id/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. |
| `url:POST\|/api/v1/courses/:course_id/enrollments`                 | Create a new user enrollment for a course or section.                                                                                                                             |
| `url:DELETE\|/api/v1/courses/:course_id/enrollments/:id`           | Conclude, deactivate, or delete an enrollment.                                                                                                                                    |
| `url:POST\|/api/v1/courses/:course_id/enrollments/:id/accept`      | accepts a pending course invitation for the current user                                                                                                                          |
| `url:PUT\|/api/v1/courses/:course_id/enrollments/:id/reactivate`   | Activates an inactive enrollment                                                                                                                                                  |
| `url:POST\|/api/v1/courses/:course_id/enrollments/:id/reject`      | rejects a pending course invitation for the current user                                                                                                                          |
| `url:PUT\|/api/v1/courses/:course_id/users/:user_id/last_attended` | Add last attended date to student enrollment in course                                                                                                                            |
| `url:GET\|/api/v1/sections/:section_id/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. |
| `url:POST\|/api/v1/sections/:section_id/enrollments`               | Create a new user enrollment for a course or section.                                                                                                                             |
| `url:GET\|/api/v1/temporary_enrollment_status`                     | Returns temporary enrollment statuses for multiple users at once.                                                                                                                 |
| `url:GET\|/api/v1/users/:user_id/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. |
| `url:GET\|/api/v1/users/:user_id/temporary_enrollment_status`      | Returns a JSON Object containing the temporary enrollment status for a user.                                                                                                      |

</details>

<details>

<summary><strong>Error Reports</strong> (1 endpoint)</summary>

| Scope                             | Description                                                                                                                                      |
| --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| `url:POST\|/api/v1/error_reports` | Create a new error report documenting an experienced problem Performs the same action as when a user uses the "help -> report a problem" dialog. |

</details>

<details>

<summary><strong>External Tools</strong> (19 endpoints)</summary>

| Scope                                                                           | Description                                                                                                                                                                                    |
| ------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `url:GET\|/api/v1/accounts/:account_id/external_tools`                          | Returns the paginated list of external tools for the current context.                                                                                                                          |
| `url:POST\|/api/v1/accounts/:account_id/external_tools`                         | Create an external tool in the specified course/account.                                                                                                                                       |
| `url:DELETE\|/api/v1/accounts/:account_id/external_tools/:external_tool_id`     | Remove the specified external tool                                                                                                                                                             |
| `url:GET\|/api/v1/accounts/:account_id/external_tools/:external_tool_id`        | Returns the specified external tool.                                                                                                                                                           |
| `url:PUT\|/api/v1/accounts/:account_id/external_tools/:external_tool_id`        | Update the specified external tool.                                                                                                                                                            |
| `url:DELETE\|/api/v1/accounts/:account_id/external_tools/rce_favorites/:id`     | Unmark the specified external tool as a favorite in the RCE editor for the given account.                                                                                                      |
| `url:POST\|/api/v1/accounts/:account_id/external_tools/rce_favorites/:id`       | Mark the specified editor\_button 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). |
| `url:GET\|/api/v1/accounts/:account_id/external_tools/sessionless_launch`       | Returns a sessionless launch url for an external tool.                                                                                                                                         |
| `url:DELETE\|/api/v1/accounts/:account_id/external_tools/top_nav_favorites/:id` | Removes the dedicated button in Top Navigation for the specified tool for the given account.                                                                                                   |
| `url:POST\|/api/v1/accounts/:account_id/external_tools/top_nav_favorites/:id`   | Adds a dedicated button in Top Navigation for the specified tool for the given account.                                                                                                        |
| `url:GET\|/api/v1/courses/:course_id/external_tools`                            | Returns the paginated list of external tools for the current context.                                                                                                                          |
| `url:POST\|/api/v1/courses/:course_id/external_tools`                           | Create an external tool in the specified course/account.                                                                                                                                       |
| `url:DELETE\|/api/v1/courses/:course_id/external_tools/:external_tool_id`       | Remove the specified external tool                                                                                                                                                             |
| `url:GET\|/api/v1/courses/:course_id/external_tools/:external_tool_id`          | Returns the specified external tool.                                                                                                                                                           |
| `url:PUT\|/api/v1/courses/:course_id/external_tools/:external_tool_id`          | Update the specified external tool.                                                                                                                                                            |
| `url:GET\|/api/v1/courses/:course_id/external_tools/sessionless_launch`         | Returns a sessionless launch url for an external tool.                                                                                                                                         |
| `url:GET\|/api/v1/courses/:course_id/external_tools/visible_course_nav_tools`   | Get a list of external tools with the course\_navigation placement that have not been hidden in course settings and whose visibility settings apply to the requesting user.                    |
| `url:GET\|/api/v1/external_tools/visible_course_nav_tools`                      | Get a list of external tools with the course\_navigation placement that have not been hidden in course settings and whose visibility settings apply to the requesting user.                    |
| `url:GET\|/api/v1/groups/:group_id/external_tools`                              | Returns the paginated list of external tools for the current context.                                                                                                                          |

</details>

<details>

<summary><strong>Favorites</strong> (8 endpoints)</summary>

| Scope                                                  | Description                                                                                               |
| ------------------------------------------------------ | --------------------------------------------------------------------------------------------------------- |
| `url:DELETE\|/api/v1/users/self/favorites/courses`     | Reset the current user's course favorites to the default automatically generated list of enrolled courses |
| `url:GET\|/api/v1/users/self/favorites/courses`        | Retrieve the paginated list of favorite courses for the current user.                                     |
| `url:DELETE\|/api/v1/users/self/favorites/courses/:id` | Remove a course from the current user's favorites.                                                        |
| `url:POST\|/api/v1/users/self/favorites/courses/:id`   | Add a course to the current user's favorites.                                                             |
| `url:DELETE\|/api/v1/users/self/favorites/groups`      | Reset the current user's group favorites to the default automatically generated list of enrolled group    |
| `url:GET\|/api/v1/users/self/favorites/groups`         | Retrieve the paginated list of favorite groups for the current user.                                      |
| `url:DELETE\|/api/v1/users/self/favorites/groups/:id`  | Remove a group from the current user's favorites.                                                         |
| `url:POST\|/api/v1/users/self/favorites/groups/:id`    | Add a group to the current user's favorites.                                                              |

</details>

<details>

<summary><strong>Feature Flags</strong> (16 endpoints)</summary>

| Scope                                                              | Description                                                                            |
| ------------------------------------------------------------------ | -------------------------------------------------------------------------------------- |
| `url:GET\|/api/v1/accounts/:account_id/features`                   | A paginated list of all features that apply to a given Account, Course, or User.       |
| `url:GET\|/api/v1/accounts/:account_id/features/enabled`           | A paginated list of all features that are enabled on a given Account, Course, or User. |
| `url:DELETE\|/api/v1/accounts/:account_id/features/flags/:feature` | Remove feature flag for a given Account, Course, or User.                              |
| `url:GET\|/api/v1/accounts/:account_id/features/flags/:feature`    | Get the feature flag that applies to a given Account, Course, or User.                 |
| `url:PUT\|/api/v1/accounts/:account_id/features/flags/:feature`    | Set a feature flag for a given Account, Course, or User.                               |
| `url:GET\|/api/v1/courses/:course_id/features`                     | A paginated list of all features that apply to a given Account, Course, or User.       |
| `url:GET\|/api/v1/courses/:course_id/features/enabled`             | A paginated list of all features that are enabled on a given Account, Course, or User. |
| `url:DELETE\|/api/v1/courses/:course_id/features/flags/:feature`   | Remove feature flag for a given Account, Course, or User.                              |
| `url:GET\|/api/v1/courses/:course_id/features/flags/:feature`      | Get the feature flag that applies to a given Account, Course, or User.                 |
| `url:PUT\|/api/v1/courses/:course_id/features/flags/:feature`      | Set a feature flag for a given Account, Course, or User.                               |
| `url:GET\|/api/v1/features/environment`                            | Return a hash of global feature options that pertain to the Canvas user interface.     |
| `url:GET\|/api/v1/users/:user_id/features`                         | A paginated list of all features that apply to a given Account, Course, or User.       |
| `url:GET\|/api/v1/users/:user_id/features/enabled`                 | A paginated list of all features that are enabled on a given Account, Course, or User. |
| `url:DELETE\|/api/v1/users/:user_id/features/flags/:feature`       | Remove feature flag for a given Account, Course, or User.                              |
| `url:GET\|/api/v1/users/:user_id/features/flags/:feature`          | Get the feature flag that applies to a given Account, Course, or User.                 |
| `url:PUT\|/api/v1/users/:user_id/features/flags/:feature`          | Set a feature flag for a given Account, Course, or User.                               |

</details>

<details>

<summary><strong>Files</strong> (62 endpoints)</summary>

| Scope                                                                            | Description                                                                                                                                            |
| -------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `url:GET\|/accounts/:account_id/files/:file_id/download`                         | Downloads the file                                                                                                                                     |
| `url:POST\|/api/v1/accounts/:account_id/folders`                                 | Creates a folder in the specified context                                                                                                              |
| `url:GET\|/api/v1/courses/:course_id/content_licenses`                           | A paginated list of licenses that can be applied                                                                                                       |
| `url:GET\|/api/v1/courses/:course_id/files`                                      | Returns the paginated list of files for the folder or course.                                                                                          |
| `url:GET\|/api/v1/courses/:course_id/files/:id`                                  | Returns the standard attachment json object                                                                                                            |
| `url:GET\|/api/v1/courses/:course_id/files/file_ref/:migration_id`               | Get information about a file from a course copy file reference                                                                                         |
| `url:GET\|/api/v1/courses/:course_id/files/quota`                                | Returns the total and used storage quota for the course, group, or user.                                                                               |
| `url:GET\|/api/v1/courses/:course_id/folders`                                    | Returns the paginated list of all folders for the given context.                                                                                       |
| `url:POST\|/api/v1/courses/:course_id/folders`                                   | Creates a folder in the specified context                                                                                                              |
| `url:GET\|/api/v1/courses/:course_id/folders/:id`                                | Returns the details for a folder You can get the root folder from a context by using 'root' as the :id.                                                |
| `url:GET\|/api/v1/courses/:course_id/folders/by_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. |
| `url:GET\|/api/v1/courses/:course_id/folders/by_path/*full_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. |
| `url:GET\|/api/v1/courses/:course_id/folders/media`                              | Returns the details for a designated upload folder that the user has rights to upload to, and creates it if it doesn't exist.                          |
| `url:DELETE\|/api/v1/courses/:course_id/usage_rights`                            | Removes copyright and license information associated with one or more files                                                                            |
| `url:PUT\|/api/v1/courses/:course_id/usage_rights`                               | Sets copyright and license information for one or more files                                                                                           |
| `url:DELETE\|/api/v1/files/:id`                                                  | Remove the specified file.                                                                                                                             |
| `url:GET\|/api/v1/files/:id`                                                     | Returns the standard attachment json object                                                                                                            |
| `url:PUT\|/api/v1/files/:id`                                                     | Update some settings on the specified file                                                                                                             |
| `url:GET\|/api/v1/files/:id/icon_metadata`                                       | Returns the icon maker file attachment metadata                                                                                                        |
| `url:GET\|/api/v1/files/:id/public_url`                                          | Determine the URL that should be used for inline preview of the file.                                                                                  |
| `url:POST\|/api/v1/files/:id/reset_verifier`                                     | Resets the link verifier.                                                                                                                              |
| `url:POST\|/api/v1/files/update_word_count`                                      | Update the word count for a submission's attachment.                                                                                                   |
| `url:POST\|/api/v1/folders/:dest_folder_id/copy_file`                            | Copy a file from elsewhere in Canvas into a folder.                                                                                                    |
| `url:POST\|/api/v1/folders/:dest_folder_id/copy_folder`                          | Copy a folder (and its contents) from elsewhere in Canvas into a folder.                                                                               |
| `url:GET\|/api/v1/folders/:folder_id/files`                                      | Returns the paginated list of files for the folder or course.                                                                                          |
| `url:POST\|/api/v1/folders/:folder_id/files`                                     | Upload a file to a folder.                                                                                                                             |
| `url:GET\|/api/v1/folders/:folder_id/folders`                                    | Returns the paginated list of folders in the folder.                                                                                                   |
| `url:POST\|/api/v1/folders/:folder_id/folders`                                   | Creates a folder in the specified context                                                                                                              |
| `url:DELETE\|/api/v1/folders/:id`                                                | Remove the specified folder.                                                                                                                           |
| `url:GET\|/api/v1/folders/:id`                                                   | Returns the details for a folder You can get the root folder from a context by using 'root' as the :id.                                                |
| `url:PUT\|/api/v1/folders/:id`                                                   | Updates a folder                                                                                                                                       |
| `url:GET\|/api/v1/groups/:group_id/content_licenses`                             | A paginated list of licenses that can be applied                                                                                                       |
| `url:GET\|/api/v1/groups/:group_id/files`                                        | Returns the paginated list of files for the folder or course.                                                                                          |
| `url:GET\|/api/v1/groups/:group_id/files/:id`                                    | Returns the standard attachment json object                                                                                                            |
| `url:GET\|/api/v1/groups/:group_id/files/quota`                                  | Returns the total and used storage quota for the course, group, or user.                                                                               |
| `url:GET\|/api/v1/groups/:group_id/folders`                                      | Returns the paginated list of all folders for the given context.                                                                                       |
| `url:POST\|/api/v1/groups/:group_id/folders`                                     | Creates a folder in the specified context                                                                                                              |
| `url:GET\|/api/v1/groups/:group_id/folders/:id`                                  | Returns the details for a folder You can get the root folder from a context by using 'root' as the :id.                                                |
| `url:GET\|/api/v1/groups/:group_id/folders/by_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. |
| `url:GET\|/api/v1/groups/:group_id/folders/by_path/*full_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. |
| `url:GET\|/api/v1/groups/:group_id/folders/media`                                | Returns the details for a designated upload folder that the user has rights to upload to, and creates it if it doesn't exist.                          |
| `url:DELETE\|/api/v1/groups/:group_id/usage_rights`                              | Removes copyright and license information associated with one or more files                                                                            |
| `url:PUT\|/api/v1/groups/:group_id/usage_rights`                                 | Sets copyright and license information for one or more files                                                                                           |
| `url:GET\|/api/v1/users/:user_id/content_licenses`                               | A paginated list of licenses that can be applied                                                                                                       |
| `url:GET\|/api/v1/users/:user_id/files`                                          | Returns the paginated list of files for the folder or course.                                                                                          |
| `url:GET\|/api/v1/users/:user_id/files/:id`                                      | Returns the standard attachment json object                                                                                                            |
| `url:GET\|/api/v1/users/:user_id/files/quota`                                    | Returns the total and used storage quota for the course, group, or user.                                                                               |
| `url:GET\|/api/v1/users/:user_id/folders`                                        | Returns the paginated list of all folders for the given context.                                                                                       |
| `url:POST\|/api/v1/users/:user_id/folders`                                       | Creates a folder in the specified context                                                                                                              |
| `url:GET\|/api/v1/users/:user_id/folders/:id`                                    | Returns the details for a folder You can get the root folder from a context by using 'root' as the :id.                                                |
| `url:GET\|/api/v1/users/:user_id/folders/by_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. |
| `url:GET\|/api/v1/users/:user_id/folders/by_path/*full_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. |
| `url:DELETE\|/api/v1/users/:user_id/usage_rights`                                | Removes copyright and license information associated with one or more files                                                                            |
| `url:PUT\|/api/v1/users/:user_id/usage_rights`                                   | Sets copyright and license information for one or more files                                                                                           |
| `url:GET\|/assessment_questions/:assessment_question_id/files/:file_id/download` | Downloads the file                                                                                                                                     |
| `url:GET\|/assignments/:assignment_id/files/:id/download`                        | Downloads the file                                                                                                                                     |
| `url:GET\|/courses/:course_id/files/:file_id/download`                           | Downloads the file                                                                                                                                     |
| `url:GET\|/files/:file_id/download`                                              | Downloads the file                                                                                                                                     |
| `url:GET\|/groups/:group_id/files/:file_id/download`                             | Downloads the file                                                                                                                                     |
| `url:GET\|/quiz_statistics/:quiz_statistics_id/files/:file_id/download`          | Downloads the file                                                                                                                                     |
| `url:GET\|/quizzes/quiz_submissions/:quiz_submission_id/files/:file_id/download` | Downloads the file                                                                                                                                     |
| `url:GET\|/users/:user_id/files/:file_id/download`                               | Downloads the file                                                                                                                                     |

</details>

<details>

<summary><strong>Grade Change Log</strong> (5 endpoints)</summary>

| Scope                                                            | Description                                               |
| ---------------------------------------------------------------- | --------------------------------------------------------- |
| `url:GET\|/api/v1/audit/grade_change`                            | List grade change events satisfying all given parameters. |
| `url:GET\|/api/v1/audit/grade_change/assignments/:assignment_id` | List grade change events for a given assignment.          |
| `url:GET\|/api/v1/audit/grade_change/courses/:course_id`         | List grade change events for a given course.              |
| `url:GET\|/api/v1/audit/grade_change/graders/:grader_id`         | List grade change events for a given grader.              |
| `url:GET\|/api/v1/audit/grade_change/students/:student_id`       | List grade change events for a given student.             |

</details>

<details>

<summary><strong>Gradebook History</strong> (4 endpoints)</summary>

| Scope                                                                                                                   | Description                                                                                            |
| ----------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ |
| `url:GET\|/api/v1/courses/:course_id/gradebook_history/:date`                                                           | Returns the graders who worked on this day, along with the assignments they worked on.                 |
| `url:GET\|/api/v1/courses/:course_id/gradebook_history/:date/graders/:grader_id/assignments/:assignment_id/submissions` | Gives a nested list of submission versions                                                             |
| `url:GET\|/api/v1/courses/:course_id/gradebook_history/days`                                                            | Returns a map of dates to grader/assignment groups                                                     |
| `url:GET\|/api/v1/courses/:course_id/gradebook_history/feed`                                                            | Gives a paginated, uncollated list of submission versions for all matching submissions in the context. |

</details>

<details>

<summary><strong>Grading Period Sets</strong> (4 endpoints)</summary>

| Scope                                                              | Description                                                                                                      |
| ------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------- |
| `url:GET\|/api/v1/accounts/:account_id/grading_period_sets`        | Returns the paginated list of grading period sets                                                                |
| `url:POST\|/api/v1/accounts/:account_id/grading_period_sets`       | Create and return a new grading period set                                                                       |
| `url:DELETE\|/api/v1/accounts/:account_id/grading_period_sets/:id` | **204 No Content** response code is returned if the deletion was successful.                                     |
| `url:PATCH\|/api/v1/accounts/:account_id/grading_period_sets/:id`  | Update an existing grading period set **204 No Content** response code is returned if the update was successful. |

</details>

<details>

<summary><strong>Grading Periods</strong> (8 endpoints)</summary>

| Scope                                                                         | Description                                                                  |
| ----------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
| `url:GET\|/api/v1/accounts/:account_id/grading_periods`                       | Returns the paginated list of grading periods for the current course.        |
| `url:DELETE\|/api/v1/accounts/:account_id/grading_periods/:id`                | **204 No Content** response code is returned if the deletion was successful. |
| `url:GET\|/api/v1/courses/:course_id/grading_periods`                         | Returns the paginated list of grading periods for the current course.        |
| `url:DELETE\|/api/v1/courses/:course_id/grading_periods/:id`                  | **204 No Content** response code is returned if the deletion was successful. |
| `url:GET\|/api/v1/courses/:course_id/grading_periods/:id`                     | Returns the grading period with the given id                                 |
| `url:PUT\|/api/v1/courses/:course_id/grading_periods/:id`                     | Update an existing grading period.                                           |
| `url:PATCH\|/api/v1/courses/:course_id/grading_periods/batch_update`          | Update multiple grading periods                                              |
| `url:PATCH\|/api/v1/grading_period_sets/:set_id/grading_periods/batch_update` | Update multiple grading periods                                              |

</details>

<details>

<summary><strong>Grading Standards</strong> (10 endpoints)</summary>

| Scope                                                                             | Description                                                                                                                      |
| --------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| `url:GET\|/api/v1/accounts/:account_id/grading_standards`                         | Returns the paginated list of grading standards for the given context that are visible to the user.                              |
| `url:POST\|/api/v1/accounts/:account_id/grading_standards`                        | Create a new grading standard                                                                                                    |
| `url:DELETE\|/api/v1/accounts/:account_id/grading_standards/:grading_standard_id` | Deletes the grading standard with the given id                                                                                   |
| `url:GET\|/api/v1/accounts/:account_id/grading_standards/:grading_standard_id`    | Returns a grading standard for the given context that is visible to the user.                                                    |
| `url:PUT\|/api/v1/accounts/:account_id/grading_standards/:grading_standard_id`    | Updates the grading standard with the given id If the grading standard has been used for grading, only the title can be updated. |
| `url:GET\|/api/v1/courses/:course_id/grading_standards`                           | Returns the paginated list of grading standards for the given context that are visible to the user.                              |
| `url:POST\|/api/v1/courses/:course_id/grading_standards`                          | Create a new grading standard                                                                                                    |
| `url:DELETE\|/api/v1/courses/:course_id/grading_standards/:grading_standard_id`   | Deletes the grading standard with the given id                                                                                   |
| `url:GET\|/api/v1/courses/:course_id/grading_standards/:grading_standard_id`      | Returns a grading standard for the given context that is visible to the user.                                                    |
| `url:PUT\|/api/v1/courses/:course_id/grading_standards/:grading_standard_id`      | Updates the grading standard with the given id If the grading standard has been used for grading, only the title can be updated. |

</details>

<details>

<summary><strong>Group Categories</strong> (16 endpoints)</summary>

| Scope                                                                                      | Description                                                                                                                                                                                                                                             |
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `url:GET\|/api/v1/accounts/:account_id/group_categories`                                   | Returns a paginated list of group categories in a context.                                                                                                                                                                                              |
| `url:POST\|/api/v1/accounts/:account_id/group_categories`                                  | Create a new group category                                                                                                                                                                                                                             |
| `url:GET\|/api/v1/courses/:course_id/group_categories`                                     | Returns a paginated list of group categories in a context.                                                                                                                                                                                              |
| `url:POST\|/api/v1/courses/:course_id/group_categories`                                    | Create a new group category                                                                                                                                                                                                                             |
| `url:POST\|/api/v1/courses/:course_id/group_categories/bulk_manage_differentiation_tag`    | This API is only meant for Groups and GroupCategories where non\_collaborative is true.                                                                                                                                                                 |
| `url:GET\|/api/v1/courses/:course_id/group_categories/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 `all_in_group_course` option), optionally narrowed by enrollment role and/or existing differentiation tag membership. |
| `url:GET\|/api/v1/courses/:course_id/group_categories/export_tags`                         | Returns a csv file of users in format ready to import.                                                                                                                                                                                                  |
| `url:POST\|/api/v1/courses/:course_id/group_categories/import_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.                                                                             |
| `url:DELETE\|/api/v1/group_categories/:group_category_id`                                  | Deletes a group category and all groups under it.                                                                                                                                                                                                       |
| `url:GET\|/api/v1/group_categories/:group_category_id`                                     | Returns the data for a single group category, or a 401 if the caller doesn't have the rights to see it.                                                                                                                                                 |
| `url:PUT\|/api/v1/group_categories/:group_category_id`                                     | Modifies an existing group category.                                                                                                                                                                                                                    |
| `url:POST\|/api/v1/group_categories/:group_category_id/assign_unassigned_members`          | Assign all unassigned members as evenly as possible among the existing student groups.                                                                                                                                                                  |
| `url:GET\|/api/v1/group_categories/:group_category_id/export`                              | Returns a csv file of users in format ready to import.                                                                                                                                                                                                  |
| `url:GET\|/api/v1/group_categories/:group_category_id/groups`                              | Returns a paginated list of groups in a group category                                                                                                                                                                                                  |
| `url:POST\|/api/v1/group_categories/:group_category_id/import`                             | 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.                                                                            |
| `url:GET\|/api/v1/group_categories/:group_category_id/users`                               | Returns a paginated list of users in the group category.                                                                                                                                                                                                |

</details>

<details>

<summary><strong>Groups</strong> (25 endpoints)</summary>

| Scope                                                             | Description                                                                                                                                                                                             |
| ----------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `url:GET\|/api/v1/accounts/:account_id/groups`                    | Returns the paginated list of active groups in the given context that are visible to user.                                                                                                              |
| `url:GET\|/api/v1/courses/:course_id/bulk_user_tags`              | Returns a mapping of user IDs to arrays of non-collaborative group (tag) IDs for each user in the given course.                                                                                         |
| `url:GET\|/api/v1/courses/:course_id/groups`                      | Returns the paginated list of active groups in the given context that are visible to user.                                                                                                              |
| `url:POST\|/api/v1/group_categories/:group_category_id/groups`    | Creates a new group.                                                                                                                                                                                    |
| `url:POST\|/api/v1/groups`                                        | Creates a new group.                                                                                                                                                                                    |
| `url:DELETE\|/api/v1/groups/:group_id`                            | Deletes a group and removes all members.                                                                                                                                                                |
| `url:GET\|/api/v1/groups/:group_id`                               | Returns the data for a single group, or a 401 if the caller doesn't have the rights to see it.                                                                                                          |
| `url:PUT\|/api/v1/groups/:group_id`                               | Modifies an existing group.                                                                                                                                                                             |
| `url:GET\|/api/v1/groups/:group_id/activity_stream`               | Returns the current user's group-specific activity stream, paginated.                                                                                                                                   |
| `url:GET\|/api/v1/groups/:group_id/activity_stream/summary`       | Returns a summary of the current user's group-specific activity stream.                                                                                                                                 |
| `url:POST\|/api/v1/groups/:group_id/files`                        | Upload a file to the group.                                                                                                                                                                             |
| `url:POST\|/api/v1/groups/:group_id/invite`                       | Sends an invitation to all supplied email addresses which will allow the receivers to join the group.                                                                                                   |
| `url:GET\|/api/v1/groups/:group_id/memberships`                   | A paginated list of the members of a group.                                                                                                                                                             |
| `url:POST\|/api/v1/groups/:group_id/memberships`                  | Join, or request to join, a group, depending on the join\_level of the group.                                                                                                                           |
| `url:DELETE\|/api/v1/groups/:group_id/memberships/:membership_id` | Leave a group if you are allowed to leave (some groups, such as sets of course groups created by teachers, cannot be left).                                                                             |
| `url:GET\|/api/v1/groups/:group_id/memberships/:membership_id`    | Returns the group membership with the given membership id or user id.                                                                                                                                   |
| `url:PUT\|/api/v1/groups/:group_id/memberships/:membership_id`    | Accept a membership request, or add/remove moderator rights.                                                                                                                                            |
| `url:GET\|/api/v1/groups/:group_id/permissions`                   | Returns permission information for the calling user in the given group.                                                                                                                                 |
| `url:POST\|/api/v1/groups/:group_id/preview_html`                 | Preview html content processed for this group                                                                                                                                                           |
| `url:DELETE\|/api/v1/groups/:group_id/users`                      | Bulk deletes memberships by providing an array of user IDs, or, for differentiation tag groups, by providing `all_in_group_course` to remove every course student matching an optional role/tag filter. |
| `url:GET\|/api/v1/groups/:group_id/users`                         | Returns a paginated list of users in the group.                                                                                                                                                         |
| `url:DELETE\|/api/v1/groups/:group_id/users/:user_id`             | Leave a group if you are allowed to leave (some groups, such as sets of course groups created by teachers, cannot be left).                                                                             |
| `url:GET\|/api/v1/groups/:group_id/users/:user_id`                | Returns the group membership with the given membership id or user id.                                                                                                                                   |
| `url:PUT\|/api/v1/groups/:group_id/users/:user_id`                | Accept a membership request, or add/remove moderator rights.                                                                                                                                            |
| `url:GET\|/api/v1/users/self/groups`                              | Returns a paginated list of active groups for the current user.                                                                                                                                         |

</details>

<details>

<summary><strong>History</strong> (1 endpoint)</summary>

| Scope                                     | Description                                           |
| ----------------------------------------- | ----------------------------------------------------- |
| `url:GET\|/api/v1/users/:user_id/history` | Return a paginated list of the user's recent history. |

</details>

<details>

<summary><strong>InstAccess tokens</strong> (1 endpoint)</summary>

| Scope                                  | Description                                  |
| -------------------------------------- | -------------------------------------------- |
| `url:POST\|/api/v1/inst_access_tokens` | Create a unique, encrypted InstAccess token. |

</details>

<details>

<summary><strong>JWTs</strong> (2 endpoints)</summary>

| Scope                            | Description                                                                                                                                       |
| -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- |
| `url:POST\|/api/v1/jwts`         | Create a unique JWT for use with other Canvas services Generates a different JWT each time it's called.                                           |
| `url:POST\|/api/v1/jwts/refresh` | 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). |

</details>

<details>

<summary><strong>LTI ContextControls</strong> (6 endpoints)</summary>

| Scope                                                                                      | Description                                                                                             |
| ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------- |
| `url:GET\|/api/v1/accounts/:account_id/lti_registrations/:registration_id/controls`        | List all LTI ContextControls for the given LTI Registration.                                            |
| `url:POST\|/api/v1/accounts/:account_id/lti_registrations/:registration_id/controls`       | Create a new LTI ContextControl for the specified LTI registration in this context.                     |
| `url:DELETE\|/api/v1/accounts/:account_id/lti_registrations/:registration_id/controls/:id` | Deletes a context control.                                                                              |
| `url:GET\|/api/v1/accounts/:account_id/lti_registrations/:registration_id/controls/:id`    | Display details of the specified LTI ContextControl for the specified LTI registration in this context. |
| `url:PUT\|/api/v1/accounts/:account_id/lti_registrations/:registration_id/controls/:id`    | Changes the availability of a context control.                                                          |
| `url:POST\|/api/v1/accounts/:account_id/lti_registrations/:registration_id/controls/bulk`  | Create up to 100 new LTI ContextControls for the specified LTI registration in this context.            |

</details>

<details>

<summary><strong>LTI Launch Definitions</strong> (2 endpoints)</summary>

| Scope                                                               | Description                                                                                           |
| ------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| `url:GET\|/api/v1/accounts/:account_id/lti_apps/launch_definitions` | List all tools available in this context for the given placements, in the form of Launch Definitions. |
| `url:GET\|/api/v1/courses/:course_id/lti_apps/launch_definitions`   | List all tools available in this context for the given placements, in the form of Launch Definitions. |

</details>

<details>

<summary><strong>LTI Registrations</strong> (36 endpoints)</summary>

| Scope                                                                                                                | Description                                                                                                                              |
| -------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| `url:GET\|/api/v1/accounts/:account_id/app_by_client_id/:client_id`                                                  | Returns details about the specified LTI registration, including the configuration and account binding.                                   |
| `url:GET\|/api/v1/accounts/:account_id/apps`                                                                         | Returns all LTI registrations in the specified account.                                                                                  |
| `url:POST\|/api/v1/accounts/:account_id/apps`                                                                        | Create a new LTI Registration, as well as an associated Tool Configuration, Developer Key, and Registration Account binding.             |
| `url:DELETE\|/api/v1/accounts/:account_id/apps/:id`                                                                  | Remove the specified LTI registration                                                                                                    |
| `url:GET\|/api/v1/accounts/:account_id/apps/:id`                                                                     | Return details about the specified LTI registration, including the configuration and account binding.                                    |
| `url:PUT\|/api/v1/accounts/:account_id/apps/:id`                                                                     | Update the specified LTI registration with the provided parameters.                                                                      |
| `url:DELETE\|/api/v1/accounts/:account_id/apps/:id/bind`                                                             | Deletes the account binding for this registration, effectively removing it from the account.                                             |
| `url:POST\|/api/v1/accounts/:account_id/apps/:id/bind`                                                               | Enable or disable the specified LTI registration for the specified root account.                                                         |
| `url:GET\|/api/v1/accounts/:account_id/apps/:id/history`                                                             | Returns the history entries for the specified LTI registration.                                                                          |
| `url:POST\|/api/v1/accounts/:account_id/apps/:id/install_from_template`                                              | This endpoint installs a local copy of a "template" LTI registration from Site Admin into the specified account.                         |
| `url:GET\|/api/v1/accounts/:account_id/apps/:id/latest_update_request`                                               | Retrieves the most recent update request for a registration, regardless of its status.                                                   |
| `url:GET\|/api/v1/accounts/:account_id/apps/:id/overlay_history`                                                     | Returns the overlay history items for the specified LTI registration.                                                                    |
| `url:PUT\|/api/v1/accounts/:account_id/apps/:id/reset`                                                               | Reset the specified LTI registration to its default settings in this context.                                                            |
| `url:GET\|/api/v1/accounts/:account_id/apps/:id/update_requests/:update_request_id`                                  | Retrieves details about a specific registration update request.                                                                          |
| `url:PUT\|/api/v1/accounts/:account_id/apps/:id/update_requests/:update_request_id/apply`                            | Applies a registration update request to an existing registration, replacing the existing configuration and overlay with the new values. |
| `url:GET\|/api/v1/accounts/:account_id/apps/:registration_id/deployments/:deployment_id/context_search`              | This is a utility endpoint used by the Canvas Apps UI and may not serve general use cases.                                               |
| `url:GET\|/api/v1/accounts/:account_id/apps/by_utid/:utid`                                                           | Returns an LTI registration by looking up its unified\_tool\_id.                                                                         |
| `url:GET\|/api/v1/accounts/:account_id/apps/install_status/:client_id`                                               | Returns the local installation status for a Site Admin LTI registration.                                                                 |
| `url:GET\|/api/v1/accounts/:account_id/lti_registration_by_client_id/:client_id`                                     | Returns details about the specified LTI registration, including the configuration and account binding.                                   |
| `url:GET\|/api/v1/accounts/:account_id/lti_registrations`                                                            | Returns all LTI registrations in the specified account.                                                                                  |
| `url:POST\|/api/v1/accounts/:account_id/lti_registrations`                                                           | Create a new LTI Registration, as well as an associated Tool Configuration, Developer Key, and Registration Account binding.             |
| `url:DELETE\|/api/v1/accounts/:account_id/lti_registrations/:id`                                                     | Remove the specified LTI registration                                                                                                    |
| `url:GET\|/api/v1/accounts/:account_id/lti_registrations/:id`                                                        | Return details about the specified LTI registration, including the configuration and account binding.                                    |
| `url:PUT\|/api/v1/accounts/:account_id/lti_registrations/:id`                                                        | Update the specified LTI registration with the provided parameters.                                                                      |
| `url:DELETE\|/api/v1/accounts/:account_id/lti_registrations/:id/bind`                                                | Deletes the account binding for this registration, effectively removing it from the account.                                             |
| `url:POST\|/api/v1/accounts/:account_id/lti_registrations/:id/bind`                                                  | Enable or disable the specified LTI registration for the specified root account.                                                         |
| `url:GET\|/api/v1/accounts/:account_id/lti_registrations/:id/history`                                                | Returns the history entries for the specified LTI registration.                                                                          |
| `url:POST\|/api/v1/accounts/:account_id/lti_registrations/:id/install_from_template`                                 | This endpoint installs a local copy of a "template" LTI registration from Site Admin into the specified account.                         |
| `url:GET\|/api/v1/accounts/:account_id/lti_registrations/:id/latest_update_request`                                  | Retrieves the most recent update request for a registration, regardless of its status.                                                   |
| `url:GET\|/api/v1/accounts/:account_id/lti_registrations/:id/overlay_history`                                        | Returns the overlay history items for the specified LTI registration.                                                                    |
| `url:PUT\|/api/v1/accounts/:account_id/lti_registrations/:id/reset`                                                  | Reset the specified LTI registration to its default settings in this context.                                                            |
| `url:GET\|/api/v1/accounts/:account_id/lti_registrations/:id/update_requests/:update_request_id`                     | Retrieves details about a specific registration update request.                                                                          |
| `url:PUT\|/api/v1/accounts/:account_id/lti_registrations/:id/update_requests/:update_request_id/apply`               | Applies a registration update request to an existing registration, replacing the existing configuration and overlay with the new values. |
| `url:GET\|/api/v1/accounts/:account_id/lti_registrations/:registration_id/deployments/:deployment_id/context_search` | This is a utility endpoint used by the Canvas Apps UI and may not serve general use cases.                                               |
| `url:GET\|/api/v1/accounts/:account_id/lti_registrations/by_utid/:utid`                                              | Returns an LTI registration by looking up its unified\_tool\_id.                                                                         |
| `url:GET\|/api/v1/accounts/:account_id/lti_registrations/install_status/:client_id`                                  | Returns the local installation status for a Site Admin LTI registration.                                                                 |

</details>

<details>

<summary><strong>LTI Resource Links</strong> (6 endpoints)</summary>

| Scope                                                           | Description                                                                                   |
| --------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| `url:GET\|/api/v1/courses/:course_id/lti_resource_links`        | Returns all Resource Links in the specified course.                                           |
| `url:POST\|/api/v1/courses/:course_id/lti_resource_links`       | Create a new LTI Resource Link in the specified course with the provided parameters.          |
| `url:DELETE\|/api/v1/courses/:course_id/lti_resource_links/:id` | Delete the specified resource link.                                                           |
| `url:GET\|/api/v1/courses/:course_id/lti_resource_links/:id`    | Return details about the specified resource link.                                             |
| `url:PUT\|/api/v1/courses/:course_id/lti_resource_links/:id`    | Update the specified resource link with the provided parameters.                              |
| `url:POST\|/api/v1/courses/:course_id/lti_resource_links/bulk`  | Create up to 100 new LTI Resource Links in the specified course with the provided parameters. |

</details>

<details>

<summary><strong>Late Policy</strong> (3 endpoints)</summary>

| Scope                                        | Description                           |
| -------------------------------------------- | ------------------------------------- |
| `url:GET\|/api/v1/courses/:id/late_policy`   | Returns the late policy for a course. |
| `url:PATCH\|/api/v1/courses/:id/late_policy` | Patch a late policy.                  |
| `url:POST\|/api/v1/courses/:id/late_policy`  | Create a late policy.                 |

</details>

<details>

<summary><strong>Learning Object Dates</strong> (11 endpoints)</summary>

| Scope                                                                                     | Description                                                                                                                                                               |
| ----------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `url:GET\|/api/v1/courses/:course_id/assignments/:assignment_id/date_details`             | 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. |
| `url:PUT\|/api/v1/courses/:course_id/assignments/:assignment_id/date_details`             | Updates date-related information for learning objects, including due date, availability dates, override status, and assignment overrides.                                 |
| `url:GET\|/api/v1/courses/:course_id/discussion_topics/:discussion_topic_id/date_details` | 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. |
| `url:PUT\|/api/v1/courses/:course_id/discussion_topics/:discussion_topic_id/date_details` | Updates date-related information for learning objects, including due date, availability dates, override status, and assignment overrides.                                 |
| `url:GET\|/api/v1/courses/:course_id/files/:attachment_id/date_details`                   | 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. |
| `url:PUT\|/api/v1/courses/:course_id/files/:attachment_id/date_details`                   | Updates date-related information for learning objects, including due date, availability dates, override status, and assignment overrides.                                 |
| `url:GET\|/api/v1/courses/:course_id/modules/:context_module_id/date_details`             | 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. |
| `url:GET\|/api/v1/courses/:course_id/pages/:url_or_id/date_details`                       | 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. |
| `url:PUT\|/api/v1/courses/:course_id/pages/:url_or_id/date_details`                       | Updates date-related information for learning objects, including due date, availability dates, override status, and assignment overrides.                                 |
| `url:GET\|/api/v1/courses/:course_id/quizzes/:quiz_id/date_details`                       | 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. |
| `url:PUT\|/api/v1/courses/:course_id/quizzes/:quiz_id/date_details`                       | Updates date-related information for learning objects, including due date, availability dates, override status, and assignment overrides.                                 |

</details>

<details>

<summary><strong>LiveAssessments</strong> (3 endpoints)</summary>

| Scope                                                                          | Description                                                                                           |
| ------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------- |
| `url:GET\|/api/v1/courses/:course_id/live_assessments`                         | Returns a paginated list of live assessments.                                                         |
| `url:POST\|/api/v1/courses/:course_id/live_assessments`                        | Creates or finds an existing live assessment with the given key and aligns it with the linked outcome |
| `url:POST\|/api/v1/courses/:course_id/live_assessments/:assessment_id/results` | Creates live assessment results and adds them to a live assessment                                    |

</details>

<details>

<summary><strong>Logins</strong> (6 endpoints)</summary>

| Scope                                              | Description                                                                           |
| -------------------------------------------------- | ------------------------------------------------------------------------------------- |
| `url:GET\|/api/v1/accounts/:account_id/logins`     | Given a user ID, return a paginated list of that user's logins for the given account. |
| `url:POST\|/api/v1/accounts/:account_id/logins`    | Create a new login for an existing user in the given account.                         |
| `url:PUT\|/api/v1/accounts/:account_id/logins/:id` | Update an existing login for a user in the given account.                             |
| `url:GET\|/api/v1/users/:user_id/logins`           | Given a user ID, return a paginated list of that user's logins for the given account. |
| `url:DELETE\|/api/v1/users/:user_id/logins/:id`    | Delete an existing login.                                                             |
| `url:POST\|/api/v1/users/reset_password`           | Given a user email, generate a nonce and email it to the user                         |

</details>

<details>

<summary><strong>Media Objects</strong> (12 endpoints)</summary>

| Scope                                                            | Description                                                                                                          |
| ---------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
| `url:GET\|/api/v1/courses/:course_id/media_attachments`          | Returns media objects created by the user making the request.                                                        |
| `url:GET\|/api/v1/courses/:course_id/media_objects`              | Returns media objects created by the user making the request.                                                        |
| `url:GET\|/api/v1/groups/:group_id/media_attachments`            | Returns media objects created by the user making the request.                                                        |
| `url:GET\|/api/v1/groups/:group_id/media_objects`                | Returns media objects created by the user making the request.                                                        |
| `url:GET\|/api/v1/media_attachments`                             | Returns media objects created by the user making the request.                                                        |
| `url:PUT\|/api/v1/media_attachments/:attachment_id`              | Updates the title of a media object.                                                                                 |
| `url:GET\|/api/v1/media_attachments/:attachment_id/media_tracks` | List the media tracks associated with a media object or attachment                                                   |
| `url:PUT\|/api/v1/media_attachments/:attachment_id/media_tracks` | Replace the media tracks associated with a media object or attachment with the array of tracks provided in the body. |
| `url:GET\|/api/v1/media_objects`                                 | Returns media objects created by the user making the request.                                                        |
| `url:PUT\|/api/v1/media_objects/:media_object_id`                | Updates the title of a media object.                                                                                 |
| `url:GET\|/api/v1/media_objects/:media_object_id/media_tracks`   | List the media tracks associated with a media object or attachment                                                   |
| `url:PUT\|/api/v1/media_objects/:media_object_id/media_tracks`   | Replace the media tracks associated with a media object or attachment with the array of tracks provided in the body. |

</details>

<details>

<summary><strong>Moderated Grading</strong> (8 endpoints)</summary>

| Scope                                                                                                            | Description                                                                                      |
| ---------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------ |
| `url:GET\|/api/v1/courses/:course_id/assignments/:assignment_id/anonymous_provisional_grades/status`             | Determine whether or not the student's submission needs one or more provisional grades.          |
| `url:GET\|/api/v1/courses/:course_id/assignments/:assignment_id/moderated_students`                              | Returns a paginated list of students selected for moderation                                     |
| `url:POST\|/api/v1/courses/:course_id/assignments/:assignment_id/moderated_students`                             | Returns an array of users that were selected for moderation                                      |
| `url:PUT\|/api/v1/courses/:course_id/assignments/:assignment_id/provisional_grades/:provisional_grade_id/select` | Choose which provisional grade the student should receive for a submission.                      |
| `url:PUT\|/api/v1/courses/:course_id/assignments/:assignment_id/provisional_grades/bulk_select`                  | Choose which provisional grades will be received by associated students for an assignment.       |
| `url:POST\|/api/v1/courses/:course_id/assignments/:assignment_id/provisional_grades/publish`                     | Publish the selected provisional grade for all submissions to an assignment.                     |
| `url:POST\|/api/v1/courses/:course_id/assignments/:assignment_id/provisional_grades/publish_async`               | Publish the selected provisional grade for all submissions to an assignment in a background job. |
| `url:GET\|/api/v1/courses/:course_id/assignments/:assignment_id/provisional_grades/status`                       | Tell whether the student's submission needs one or more provisional grades.                      |

</details>

<details>

<summary><strong>Module Organization</strong> (2 endpoints)</summary>

| Scope                                                            | Description |
| ---------------------------------------------------------------- | ----------- |
| `url:POST\|/api/v1/courses/:course_id/module_organization`       |             |
| `url:POST\|/api/v1/courses/:course_id/module_organization/apply` |             |

</details>

<details>

<summary><strong>Modules</strong> (17 endpoints)</summary>

| Scope                                                                                   | Description                                                                                                                                                          |
| --------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `url:GET\|/api/v1/courses/:course_id/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 |
| `url:GET\|/api/v1/courses/:course_id/modules`                                           | A paginated list of the modules in a course                                                                                                                          |
| `url:POST\|/api/v1/courses/:course_id/modules`                                          | Create and return a new module                                                                                                                                       |
| `url:GET\|/api/v1/courses/:course_id/modules/:context_module_id/assignment_overrides`   | Returns a paginated list of AssignmentOverrides that apply to the ContextModule.                                                                                     |
| `url:PUT\|/api/v1/courses/:course_id/modules/:context_module_id/assignment_overrides`   | Accepts a list of overrides and applies them to the ContextModule.                                                                                                   |
| `url:DELETE\|/api/v1/courses/:course_id/modules/:id`                                    | Delete a module                                                                                                                                                      |
| `url:GET\|/api/v1/courses/:course_id/modules/:id`                                       | Get information about a single module                                                                                                                                |
| `url:PUT\|/api/v1/courses/:course_id/modules/:id`                                       | Update and return an existing module                                                                                                                                 |
| `url:PUT\|/api/v1/courses/:course_id/modules/:id/relock`                                | Resets module progressions to their default locked state and recalculates them based on the current requirements.                                                    |
| `url:GET\|/api/v1/courses/:course_id/modules/:module_id/items`                          | A paginated list of the items in a module                                                                                                                            |
| `url:POST\|/api/v1/courses/:course_id/modules/:module_id/items`                         | Create and return a new module item                                                                                                                                  |
| `url:DELETE\|/api/v1/courses/:course_id/modules/:module_id/items/:id`                   | Delete a module item                                                                                                                                                 |
| `url:GET\|/api/v1/courses/:course_id/modules/:module_id/items/:id`                      | Get information about a single module item                                                                                                                           |
| `url:PUT\|/api/v1/courses/:course_id/modules/:module_id/items/:id`                      | Update and return an existing module item                                                                                                                            |
| `url:PUT\|/api/v1/courses/:course_id/modules/:module_id/items/:id/done`                 | Mark a module item as done/not done.                                                                                                                                 |
| `url:POST\|/api/v1/courses/:course_id/modules/:module_id/items/:id/mark_read`           | Fulfills "must view" requirement for a module item.                                                                                                                  |
| `url:POST\|/api/v1/courses/:course_id/modules/:module_id/items/:id/select_mastery_path` | Select a mastery path when module item includes several possible paths.                                                                                              |

</details>

<details>

<summary><strong>New Quiz Items</strong> (6 endpoints)</summary>

| Scope                                                                                    | Description                                                       |
| ---------------------------------------------------------------------------------------- | ----------------------------------------------------------------- |
| `url:GET\|/api/quiz/v1/courses/:course_id/quizzes/:assignment_id/items`                  | Get a list of items in a new quiz.                                |
| `url:POST\|/api/quiz/v1/courses/:course_id/quizzes/:assignment_id/items`                 | Create a quiz item in a new quiz.                                 |
| `url:DELETE\|/api/quiz/v1/courses/:course_id/quizzes/:assignment_id/items/:item_id`      | Delete a single quiz item in a new quiz.                          |
| `url:GET\|/api/quiz/v1/courses/:course_id/quizzes/:assignment_id/items/:item_id`         | Get details about a single item in a new quiz.                    |
| `url:PATCH\|/api/quiz/v1/courses/:course_id/quizzes/:assignment_id/items/:item_id`       | Update a single quiz item in a new quiz.                          |
| `url:GET\|/api/quiz/v1/courses/:course_id/quizzes/:assignment_id/items/media_upload_url` | Get a url for uploading media for use in hot-spot question types. |

</details>

<details>

<summary><strong>New Quizzes Accommodations</strong> (2 endpoints)</summary>

| Scope                                                                             | Description                                                                           |
| --------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
| `url:POST\|/api/quiz/v1/courses/:course_id/accommodations`                        | Apply accommodations at the **course level** for students enrolled in a given course. |
| `url:POST\|/api/quiz/v1/courses/:course_id/quizzes/:assignment_id/accommodations` | Apply accommodations at the **quiz level** for students in a specific assignment.     |

</details>

<details>

<summary><strong>New Quizzes Reports</strong> (1 endpoint)</summary>

| Scope                                                                      | Description                          |
| -------------------------------------------------------------------------- | ------------------------------------ |
| `url:POST\|/api/quiz/v1/courses/:course_id/quizzes/:assignment_id/reports` | Generate a new report for this quiz. |

</details>

<details>

<summary><strong>Notification Preferences</strong> (10 endpoints)</summary>

| Scope                                                                                                                       | Description                                                                                                |
| --------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
| `url:GET\|/api/v1/users/:user_id/communication_channels/:communication_channel_id/notification_preference_categories`       | Fetch all notification preference categories for the given communication channel                           |
| `url:GET\|/api/v1/users/:user_id/communication_channels/:communication_channel_id/notification_preferences`                 | Fetch all preferences for the given communication channel                                                  |
| `url:GET\|/api/v1/users/:user_id/communication_channels/:communication_channel_id/notification_preferences/:notification`   | Fetch the preference for the given notification for the given communication channel                        |
| `url:GET\|/api/v1/users/:user_id/communication_channels/:type/:address/notification_preferences`                            | Fetch all preferences for the given communication channel                                                  |
| `url:GET\|/api/v1/users/:user_id/communication_channels/:type/:address/notification_preferences/:notification`              | Fetch the preference for the given notification for the given communication channel                        |
| `url:PUT\|/api/v1/users/self/communication_channels/:communication_channel_id/notification_preference_categories/:category` | Change the preferences for multiple notifications based on the category for a single communication channel |
| `url:PUT\|/api/v1/users/self/communication_channels/:communication_channel_id/notification_preferences`                     | Change the preferences for multiple notifications for a single communication channel at once               |
| `url:PUT\|/api/v1/users/self/communication_channels/:communication_channel_id/notification_preferences/:notification`       | Change the preference for a single notification for a single communication channel                         |
| `url:PUT\|/api/v1/users/self/communication_channels/:type/:address/notification_preferences`                                | Change the preferences for multiple notifications for a single communication channel at once               |
| `url:PUT\|/api/v1/users/self/communication_channels/:type/:address/notification_preferences/:notification`                  | Change the preference for a single notification for a single communication channel                         |

</details>

<details>

<summary><strong>Outcome Groups</strong> (37 endpoints)</summary>

| Scope                                                                              | Description                                                                                                                                                                                            |
| ---------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `url:GET\|/api/v1/accounts/:account_id/outcome_group_links`                        | Returns a list of all outcome links in the specified context.                                                                                                                                          |
| `url:GET\|/api/v1/accounts/:account_id/outcome_groups`                             | Returns a list of all outcome groups in the specified context.                                                                                                                                         |
| `url:DELETE\|/api/v1/accounts/:account_id/outcome_groups/:id`                      | Deleting an outcome group deletes descendant outcome groups and outcome links.                                                                                                                         |
| `url:GET\|/api/v1/accounts/:account_id/outcome_groups/:id`                         | Returns detailed information about a specific outcome group.                                                                                                                                           |
| `url:PUT\|/api/v1/accounts/:account_id/outcome_groups/:id`                         | Modify an existing outcome group.                                                                                                                                                                      |
| `url:POST\|/api/v1/accounts/:account_id/outcome_groups/:id/import`                 | 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. |
| `url:GET\|/api/v1/accounts/:account_id/outcome_groups/:id/outcomes`                | A paginated list of the immediate OutcomeLink children of the outcome group.                                                                                                                           |
| `url:POST\|/api/v1/accounts/:account_id/outcome_groups/:id/outcomes`               | Link an outcome into the outcome group.                                                                                                                                                                |
| `url:DELETE\|/api/v1/accounts/:account_id/outcome_groups/:id/outcomes/:outcome_id` | Unlinking an outcome only deletes the outcome itself if this was the last link to the outcome in any group in any context.                                                                             |
| `url:POST\|/api/v1/accounts/:account_id/outcome_groups/:id/outcomes/:outcome_id`   | Link an outcome into the outcome group.                                                                                                                                                                |
| `url:GET\|/api/v1/accounts/:account_id/outcome_groups/:id/subgroups`               | A paginated list of the immediate OutcomeGroup children of the outcome group.                                                                                                                          |
| `url:POST\|/api/v1/accounts/:account_id/outcome_groups/:id/subgroups`              | Creates a new empty subgroup under the outcome group with the given title and description.                                                                                                             |
| `url:GET\|/api/v1/accounts/:account_id/root_outcome_group`                         | Convenience redirect to find the root outcome group for a particular context.                                                                                                                          |
| `url:GET\|/api/v1/courses/:course_id/outcome_group_links`                          | Returns a list of all outcome links in the specified context.                                                                                                                                          |
| `url:GET\|/api/v1/courses/:course_id/outcome_groups`                               | Returns a list of all outcome groups in the specified context.                                                                                                                                         |
| `url:DELETE\|/api/v1/courses/:course_id/outcome_groups/:id`                        | Deleting an outcome group deletes descendant outcome groups and outcome links.                                                                                                                         |
| `url:GET\|/api/v1/courses/:course_id/outcome_groups/:id`                           | Returns detailed information about a specific outcome group.                                                                                                                                           |
| `url:PUT\|/api/v1/courses/:course_id/outcome_groups/:id`                           | Modify an existing outcome group.                                                                                                                                                                      |
| `url:POST\|/api/v1/courses/:course_id/outcome_groups/:id/import`                   | 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. |
| `url:GET\|/api/v1/courses/:course_id/outcome_groups/:id/outcomes`                  | A paginated list of the immediate OutcomeLink children of the outcome group.                                                                                                                           |
| `url:POST\|/api/v1/courses/:course_id/outcome_groups/:id/outcomes`                 | Link an outcome into the outcome group.                                                                                                                                                                |
| `url:DELETE\|/api/v1/courses/:course_id/outcome_groups/:id/outcomes/:outcome_id`   | Unlinking an outcome only deletes the outcome itself if this was the last link to the outcome in any group in any context.                                                                             |
| `url:POST\|/api/v1/courses/:course_id/outcome_groups/:id/outcomes/:outcome_id`     | Link an outcome into the outcome group.                                                                                                                                                                |
| `url:GET\|/api/v1/courses/:course_id/outcome_groups/:id/subgroups`                 | A paginated list of the immediate OutcomeGroup children of the outcome group.                                                                                                                          |
| `url:POST\|/api/v1/courses/:course_id/outcome_groups/:id/subgroups`                | Creates a new empty subgroup under the outcome group with the given title and description.                                                                                                             |
| `url:GET\|/api/v1/courses/:course_id/root_outcome_group`                           | Convenience redirect to find the root outcome group for a particular context.                                                                                                                          |
| `url:DELETE\|/api/v1/global/outcome_groups/:id`                                    | Deleting an outcome group deletes descendant outcome groups and outcome links.                                                                                                                         |
| `url:GET\|/api/v1/global/outcome_groups/:id`                                       | Returns detailed information about a specific outcome group.                                                                                                                                           |
| `url:PUT\|/api/v1/global/outcome_groups/:id`                                       | Modify an existing outcome group.                                                                                                                                                                      |
| `url:POST\|/api/v1/global/outcome_groups/:id/import`                               | 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. |
| `url:GET\|/api/v1/global/outcome_groups/:id/outcomes`                              | A paginated list of the immediate OutcomeLink children of the outcome group.                                                                                                                           |
| `url:POST\|/api/v1/global/outcome_groups/:id/outcomes`                             | Link an outcome into the outcome group.                                                                                                                                                                |
| `url:DELETE\|/api/v1/global/outcome_groups/:id/outcomes/:outcome_id`               | Unlinking an outcome only deletes the outcome itself if this was the last link to the outcome in any group in any context.                                                                             |
| `url:POST\|/api/v1/global/outcome_groups/:id/outcomes/:outcome_id`                 | Link an outcome into the outcome group.                                                                                                                                                                |
| `url:GET\|/api/v1/global/outcome_groups/:id/subgroups`                             | A paginated list of the immediate OutcomeGroup children of the outcome group.                                                                                                                          |
| `url:POST\|/api/v1/global/outcome_groups/:id/subgroups`                            | Creates a new empty subgroup under the outcome group with the given title and description.                                                                                                             |
| `url:GET\|/api/v1/global/root_outcome_group`                                       | Convenience redirect to find the root outcome group for a particular context.                                                                                                                          |

</details>

<details>

<summary><strong>Outcome Imports</strong> (6 endpoints)</summary>

| Scope                                                                                       | Description                                                          |
| ------------------------------------------------------------------------------------------- | -------------------------------------------------------------------- |
| `url:POST\|/api/v1/accounts/:account_id/outcome_imports(/group/:learning_outcome_group_id)` | Import outcomes into Canvas.                                         |
| `url:GET\|/api/v1/accounts/:account_id/outcome_imports/:id`                                 | Get the status of an already created Outcome import.                 |
| `url:GET\|/api/v1/accounts/:account_id/outcome_imports/:id/created_group_ids`               | Get the IDs of the outcome groups created after a successful import. |
| `url:POST\|/api/v1/courses/:course_id/outcome_imports(/group/:learning_outcome_group_id)`   | Import outcomes into Canvas.                                         |
| `url:GET\|/api/v1/courses/:course_id/outcome_imports/:id`                                   | Get the status of an already created Outcome import.                 |
| `url:GET\|/api/v1/courses/:course_id/outcome_imports/:id/created_group_ids`                 | Get the IDs of the outcome groups created after a successful import. |

</details>

<details>

<summary><strong>Outcome Results</strong> (6 endpoints)</summary>

| Scope                                                                          | Description                                                                        |
| ------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------- |
| `url:POST\|/api/v1/courses/:course_id/assign_outcome_order`                    | Saves the ordering of outcomes in LMGB for a user                                  |
| `url:POST\|/api/v1/courses/:course_id/enqueue_outcome_rollup_calculation`      |                                                                                    |
| `url:GET\|/api/v1/courses/:course_id/outcome_mastery_distribution`             | Returns the distribution of student scores across mastery levels for all outcomes. |
| `url:GET\|/api/v1/courses/:course_id/outcome_results`                          | Gets the outcome results for users and outcomes in the specified context.          |
| `url:GET\|/api/v1/courses/:course_id/outcome_rollups`                          | Gets the outcome rollups for the users and outcomes in the specified context.      |
| `url:GET\|/api/v1/courses/:course_id/outcomes/:outcome_id/contributing_scores` | Gets the contributing scores for a specific outcome and set of users.              |

</details>

<details>

<summary><strong>Outcomes</strong> (3 endpoints)</summary>

| Scope                                                    | Description                                                         |
| -------------------------------------------------------- | ------------------------------------------------------------------- |
| `url:GET\|/api/v1/courses/:course_id/outcome_alignments` | Returns outcome alignments for a student or assignment in a course. |
| `url:GET\|/api/v1/outcomes/:id`                          | Returns the details of the outcome with the given id.               |
| `url:PUT\|/api/v1/outcomes/:id`                          | Modify an existing outcome.                                         |

</details>

<details>

<summary><strong>Pages</strong> (23 endpoints)</summary>

| Scope                                                                          | Description                                                                                       |
| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------- |
| `url:GET\|/api/v1/courses/:course_id/front_page`                               | Retrieve the content of the front page                                                            |
| `url:PUT\|/api/v1/courses/:course_id/front_page`                               | Update the title or contents of the front page                                                    |
| `url:GET\|/api/v1/courses/:course_id/pages`                                    | A paginated list of the wiki pages associated with a course or group                              |
| `url:POST\|/api/v1/courses/:course_id/pages`                                   | Create a new wiki page                                                                            |
| `url:DELETE\|/api/v1/courses/:course_id/pages/:url_or_id`                      | Delete a wiki page                                                                                |
| `url:GET\|/api/v1/courses/:course_id/pages/:url_or_id`                         | Retrieve the content of a wiki page                                                               |
| `url:PUT\|/api/v1/courses/:course_id/pages/:url_or_id`                         | Update the title or contents of a wiki page NOTE: You cannot specify the ID when creating a page. |
| `url:POST\|/api/v1/courses/:course_id/pages/:url_or_id/duplicate`              | Duplicate a wiki page                                                                             |
| `url:GET\|/api/v1/courses/:course_id/pages/:url_or_id/revisions`               | A paginated list of the revisions of a page.                                                      |
| `url:GET\|/api/v1/courses/:course_id/pages/:url_or_id/revisions/:revision_id`  | Retrieve the metadata and optionally content of a revision of the page.                           |
| `url:POST\|/api/v1/courses/:course_id/pages/:url_or_id/revisions/:revision_id` | Revert a page to a prior revision.                                                                |
| `url:GET\|/api/v1/courses/:course_id/pages/:url_or_id/revisions/latest`        | Retrieve the metadata and optionally content of a revision of the page.                           |
| `url:GET\|/api/v1/groups/:group_id/front_page`                                 | Retrieve the content of the front page                                                            |
| `url:PUT\|/api/v1/groups/:group_id/front_page`                                 | Update the title or contents of the front page                                                    |
| `url:GET\|/api/v1/groups/:group_id/pages`                                      | A paginated list of the wiki pages associated with a course or group                              |
| `url:POST\|/api/v1/groups/:group_id/pages`                                     | Create a new wiki page                                                                            |
| `url:DELETE\|/api/v1/groups/:group_id/pages/:url_or_id`                        | Delete a wiki page                                                                                |
| `url:GET\|/api/v1/groups/:group_id/pages/:url_or_id`                           | Retrieve the content of a wiki page                                                               |
| `url:PUT\|/api/v1/groups/:group_id/pages/:url_or_id`                           | Update the title or contents of a wiki page NOTE: You cannot specify the ID when creating a page. |
| `url:GET\|/api/v1/groups/:group_id/pages/:url_or_id/revisions`                 | A paginated list of the revisions of a page.                                                      |
| `url:GET\|/api/v1/groups/:group_id/pages/:url_or_id/revisions/:revision_id`    | Retrieve the metadata and optionally content of a revision of the page.                           |
| `url:POST\|/api/v1/groups/:group_id/pages/:url_or_id/revisions/:revision_id`   | Revert a page to a prior revision.                                                                |
| `url:GET\|/api/v1/groups/:group_id/pages/:url_or_id/revisions/latest`          | Retrieve the metadata and optionally content of a revision of the page.                           |

</details>

<details>

<summary><strong>Peer Reviews</strong> (9 endpoints)</summary>

| Scope                                                                                                         | Description                                                |
| ------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- |
| `url:POST\|/api/v1/courses/:course_id/assignments/:assignment_id/allocate`                                    | Allocates a submission for the current user to peer review |
| `url:GET\|/api/v1/courses/:course_id/assignments/:assignment_id/peer_reviews`                                 | Get a list of all Peer Reviews for this assignment         |
| `url:DELETE\|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:submission_id/peer_reviews`   | Delete a peer review for the assignment                    |
| `url:GET\|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:submission_id/peer_reviews`      | Get a list of all Peer Reviews for this assignment         |
| `url:POST\|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:submission_id/peer_reviews`     | Create a peer review for the assignment                    |
| `url:GET\|/api/v1/sections/:section_id/assignments/:assignment_id/peer_reviews`                               | Get a list of all Peer Reviews for this assignment         |
| `url:DELETE\|/api/v1/sections/:section_id/assignments/:assignment_id/submissions/:submission_id/peer_reviews` | Delete a peer review for the assignment                    |
| `url:GET\|/api/v1/sections/:section_id/assignments/:assignment_id/submissions/:submission_id/peer_reviews`    | Get a list of all Peer Reviews for this assignment         |
| `url:POST\|/api/v1/sections/:section_id/assignments/:assignment_id/submissions/:submission_id/peer_reviews`   | Create a peer review for the assignment                    |

</details>

<details>

<summary><strong>Planner</strong> (12 endpoints)</summary>

| Scope                                           | Description                                                                                                                                                          |
| ----------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `url:GET\|/api/v1/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. |
| `url:GET\|/api/v1/planner/overrides`            | Retrieve a planner override for the current user                                                                                                                     |
| `url:POST\|/api/v1/planner/overrides`           | Create a planner override for the current user                                                                                                                       |
| `url:DELETE\|/api/v1/planner/overrides/:id`     | Delete a planner override for the current user                                                                                                                       |
| `url:GET\|/api/v1/planner/overrides/:id`        | Retrieve a planner override for the current user                                                                                                                     |
| `url:PUT\|/api/v1/planner/overrides/:id`        | Update a planner override's visibilty for the current user                                                                                                           |
| `url:GET\|/api/v1/planner_notes`                | Retrieve the paginated list of planner notes Retrieve planner note for a user                                                                                        |
| `url:POST\|/api/v1/planner_notes`               | Create a planner note for the current user                                                                                                                           |
| `url:DELETE\|/api/v1/planner_notes/:id`         | Delete a planner note for the current user                                                                                                                           |
| `url:GET\|/api/v1/planner_notes/:id`            | Retrieve a planner note for the current user                                                                                                                         |
| `url:PUT\|/api/v1/planner_notes/:id`            | Update a planner note for the current user                                                                                                                           |
| `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. |

</details>

<details>

<summary><strong>Poll Sessions</strong> (9 endpoints)</summary>

| Scope                                                     | Description                                                                  |
| --------------------------------------------------------- | ---------------------------------------------------------------------------- |
| `url:GET\|/api/v1/poll_sessions/closed`                   | A paginated list of all closed poll sessions available to the current user.  |
| `url:GET\|/api/v1/poll_sessions/opened`                   | A paginated list of all opened poll sessions available to the current user.  |
| `url:GET\|/api/v1/polls/:poll_id/poll_sessions`           | Returns the paginated list of PollSessions in this poll.                     |
| `url:POST\|/api/v1/polls/:poll_id/poll_sessions`          | Create a new poll session for this poll                                      |
| `url:DELETE\|/api/v1/polls/:poll_id/poll_sessions/:id`    | **204 No Content** response code is returned if the deletion was successful. |
| `url:GET\|/api/v1/polls/:poll_id/poll_sessions/:id`       | Returns the poll session with the given id                                   |
| `url:PUT\|/api/v1/polls/:poll_id/poll_sessions/:id`       | Update an existing poll session for this poll                                |
| `url:GET\|/api/v1/polls/:poll_id/poll_sessions/:id/close` |                                                                              |
| `url:GET\|/api/v1/polls/:poll_id/poll_sessions/:id/open`  |                                                                              |

</details>

<details>

<summary><strong>PollChoices</strong> (5 endpoints)</summary>

| Scope                                                 | Description                                                                  |
| ----------------------------------------------------- | ---------------------------------------------------------------------------- |
| `url:GET\|/api/v1/polls/:poll_id/poll_choices`        | Returns the paginated list of PollChoices in this poll.                      |
| `url:POST\|/api/v1/polls/:poll_id/poll_choices`       | Create a new poll choice for this poll                                       |
| `url:DELETE\|/api/v1/polls/:poll_id/poll_choices/:id` | **204 No Content** response code is returned if the deletion was successful. |
| `url:GET\|/api/v1/polls/:poll_id/poll_choices/:id`    | Returns the poll choice with the given id                                    |
| `url:PUT\|/api/v1/polls/:poll_id/poll_choices/:id`    | Update an existing poll choice for this poll                                 |

</details>

<details>

<summary><strong>PollSubmissions</strong> (2 endpoints)</summary>

| Scope                                                                                 | Description                                        |
| ------------------------------------------------------------------------------------- | -------------------------------------------------- |
| `url:POST\|/api/v1/polls/:poll_id/poll_sessions/:poll_session_id/poll_submissions`    | Create a new poll submission for this poll session |
| `url:GET\|/api/v1/polls/:poll_id/poll_sessions/:poll_session_id/poll_submissions/:id` | Returns the poll submission with the given id      |

</details>

<details>

<summary><strong>Polls</strong> (5 endpoints)</summary>

| Scope                           | Description                                                                  |
| ------------------------------- | ---------------------------------------------------------------------------- |
| `url:GET\|/api/v1/polls`        | Returns the paginated list of polls for the current user.                    |
| `url:POST\|/api/v1/polls`       | Create a new poll for the current user                                       |
| `url:DELETE\|/api/v1/polls/:id` | **204 No Content** response code is returned if the deletion was successful. |
| `url:GET\|/api/v1/polls/:id`    | Returns the poll with the given id                                           |
| `url:PUT\|/api/v1/polls/:id`    | Update an existing poll belonging to the current user                        |

</details>

<details>

<summary><strong>Portfolio Notifications</strong> (1 endpoint)</summary>

| Scope                                                      | Description |
| ---------------------------------------------------------- | ----------- |
| `url:POST\|/api/v1/users/:user_id/portfolio_notifications` |             |

</details>

<details>

<summary><strong>Proficiency Ratings</strong> (4 endpoints)</summary>

| Scope                                                        | Description                                         |
| ------------------------------------------------------------ | --------------------------------------------------- |
| `url:GET\|/api/v1/accounts/:account_id/outcome_proficiency`  | Get account-level proficiency ratings.              |
| `url:POST\|/api/v1/accounts/:account_id/outcome_proficiency` | Create or update account-level proficiency ratings. |
| `url:GET\|/api/v1/courses/:course_id/outcome_proficiency`    | Get account-level proficiency ratings.              |
| `url:POST\|/api/v1/courses/:course_id/outcome_proficiency`   | Create or update account-level proficiency ratings. |

</details>

<details>

<summary><strong>Progress</strong> (2 endpoints)</summary>

| Scope                                   | Description                                                                                                                                            |
| --------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `url:GET\|/api/v1/progress/:id`         | Return completion and status information about an asynchronous job                                                                                     |
| `url:POST\|/api/v1/progress/:id/cancel` | 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. |

</details>

<details>

<summary><strong>Quiz Assignment Overrides</strong> (2 endpoints)</summary>

| Scope                                                                  | Description                                                                                                                                  |
| ---------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| `url:GET\|/api/v1/courses/:course_id/new_quizzes/assignment_overrides` | Retrieve the actual due-at, unlock-at, and available-at dates for quizzes based on the assignment overrides active for the current API user. |
| `url:GET\|/api/v1/courses/:course_id/quizzes/assignment_overrides`     | Retrieve the actual due-at, unlock-at, and available-at dates for quizzes based on the assignment overrides active for the current API user. |

</details>

<details>

<summary><strong>Quiz Extensions</strong> (1 endpoint)</summary>

| Scope                                                              | Description                                                                                                                             |
| ------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------- |
| `url:POST\|/api/v1/courses/:course_id/quizzes/:quiz_id/extensions` | **Responses** \* **200 OK** if the request was successful \* **403 Forbidden** if you are not allowed to extend quizzes for this course |

</details>

<details>

<summary><strong>Quiz IP Filters</strong> (1 endpoint)</summary>

| Scope                                                             | Description                                       |
| ----------------------------------------------------------------- | ------------------------------------------------- |
| `url:GET\|/api/v1/courses/:course_id/quizzes/:quiz_id/ip_filters` | Get a list of available IP filters for this Quiz. |

</details>

<details>

<summary><strong>Quiz Question Groups</strong> (6 endpoints)</summary>

| Scope                                                                      | Description                                                                                                                         |
| -------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| `url:GET\|/api/v1/courses/:course_id/quizzes/:quiz_id/groups`              | Returns a list of question groups in a quiz.                                                                                        |
| `url:POST\|/api/v1/courses/:course_id/quizzes/:quiz_id/groups`             | Create a new question group for this quiz **201 Created** response code is returned if the creation was successful.                 |
| `url:DELETE\|/api/v1/courses/:course_id/quizzes/:quiz_id/groups/:id`       | Delete a question group **204 No Content** response code is returned if the deletion was successful.                                |
| `url:GET\|/api/v1/courses/:course_id/quizzes/:quiz_id/groups/:id`          | Returns details of the quiz group with the given id.                                                                                |
| `url:PUT\|/api/v1/courses/:course_id/quizzes/:quiz_id/groups/:id`          | Update a question group                                                                                                             |
| `url:POST\|/api/v1/courses/:course_id/quizzes/:quiz_id/groups/:id/reorder` | Change the order of the quiz questions within the group **204 No Content** response code is returned if the reorder was successful. |

</details>

<details>

<summary><strong>Quiz Questions</strong> (5 endpoints)</summary>

| Scope                                                                   | Description                                                                  |
| ----------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
| `url:GET\|/api/v1/courses/:course_id/quizzes/:quiz_id/questions`        | Returns the paginated list of QuizQuestions in this quiz.                    |
| `url:POST\|/api/v1/courses/:course_id/quizzes/:quiz_id/questions`       | Create a new quiz question for this quiz                                     |
| `url:DELETE\|/api/v1/courses/:course_id/quizzes/:quiz_id/questions/:id` | **204 No Content** response code is returned if the deletion was successful. |
| `url:GET\|/api/v1/courses/:course_id/quizzes/:quiz_id/questions/:id`    | Returns the quiz question with the given id                                  |
| `url:PUT\|/api/v1/courses/:course_id/quizzes/:quiz_id/questions/:id`    | Updates an existing quiz question for this quiz                              |

</details>

<details>

<summary><strong>Quiz Reports</strong> (4 endpoints)</summary>

| Scope                                                                 | Description                                                                               |
| --------------------------------------------------------------------- | ----------------------------------------------------------------------------------------- |
| `url:GET\|/api/v1/courses/:course_id/quizzes/:quiz_id/reports`        | Returns a list of all available reports.                                                  |
| `url:POST\|/api/v1/courses/:course_id/quizzes/:quiz_id/reports`       | Create and return a new report for this quiz.                                             |
| `url:DELETE\|/api/v1/courses/:course_id/quizzes/:quiz_id/reports/:id` | This API allows you to cancel a previous request you issued for a report to be generated. |
| `url:GET\|/api/v1/courses/:course_id/quizzes/:quiz_id/reports/:id`    | Returns the data for a single quiz report.                                                |

</details>

<details>

<summary><strong>Quiz Statistics</strong> (1 endpoint)</summary>

| Scope                                                             | Description                                                                                                                                                                                     |
| ----------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `url:GET\|/api/v1/courses/:course_id/quizzes/:quiz_id/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. |

</details>

<details>

<summary><strong>Quiz Submission Events</strong> (2 endpoints)</summary>

| Scope                                                                          | Description                                                               |
| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------- |
| `url:GET\|/api/v1/courses/:course_id/quizzes/:quiz_id/submissions/:id/events`  | Retrieve the set of events captured during a specific submission attempt. |
| `url:POST\|/api/v1/courses/:course_id/quizzes/:quiz_id/submissions/:id/events` | Store a set of events which were captured during a quiz taking session.   |

</details>

<details>

<summary><strong>Quiz Submission Files</strong> (1 endpoint)</summary>

| Scope                                                                          | Description                                                                                                   |
| ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------- |
| `url:POST\|/api/v1/courses/:course_id/quizzes/:quiz_id/submissions/self/files` | Associate a new quiz submission file This API endpoint is the first step in uploading a quiz submission file. |

</details>

<details>

<summary><strong>Quiz Submission Questions</strong> (5 endpoints)</summary>

| Scope                                                                                  | Description                                                                                                           |
| -------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
| `url:GET\|/api/v1/quiz_submissions/:quiz_submission_id/questions`                      | Get a list of all the question records for this quiz submission.                                                      |
| `url:POST\|/api/v1/quiz_submissions/:quiz_submission_id/questions`                     | Provide or update an answer to one or more QuizQuestions.                                                             |
| `url:PUT\|/api/v1/quiz_submissions/:quiz_submission_id/questions/:id/flag`             | Set a flag on a quiz question to indicate that you want to return to it later.                                        |
| `url:GET\|/api/v1/quiz_submissions/:quiz_submission_id/questions/:id/formatted_answer` | Matches the intended behavior of the UI when a numerical answer is entered and returns the resulting formatted number |
| `url:PUT\|/api/v1/quiz_submissions/:quiz_submission_id/questions/:id/unflag`           | Remove the flag that you previously set on a quiz question after you've returned to it.                               |

</details>

<details>

<summary><strong>Quiz Submission User List</strong> (1 endpoint)</summary>

| Scope                                                                       | Description                                                                                                                      |
| --------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| `url:POST\|/api/v1/courses/:course_id/quizzes/:id/submission_users/message` | { "body": { "type": "string", "description": "message body of the conversation to be created", "example": "Please take the quiz. |

</details>

<details>

<summary><strong>Quiz Submissions</strong> (7 endpoints)</summary>

| Scope                                                                            | Description                                                                                                                                                                                              |
| -------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `url:GET\|/api/v1/courses/:course_id/quizzes/:quiz_id/submission`                | Get the submission for this quiz for the current user.                                                                                                                                                   |
| `url:GET\|/api/v1/courses/:course_id/quizzes/:quiz_id/submissions`               | Get a list of all submissions for this quiz.                                                                                                                                                             |
| `url:POST\|/api/v1/courses/:course_id/quizzes/:quiz_id/submissions`              | Start taking a Quiz by creating a QuizSubmission which you can use to answer questions and submit your answers.                                                                                          |
| `url:GET\|/api/v1/courses/:course_id/quizzes/:quiz_id/submissions/:id`           | Get a single quiz submission.                                                                                                                                                                            |
| `url:PUT\|/api/v1/courses/:course_id/quizzes/:quiz_id/submissions/:id`           | 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. |
| `url:POST\|/api/v1/courses/:course_id/quizzes/:quiz_id/submissions/:id/complete` | Complete the quiz submission by marking it as complete and grading it.                                                                                                                                   |
| `url:GET\|/api/v1/courses/:course_id/quizzes/:quiz_id/submissions/:id/time`      | Get the current timing data for the quiz attempt, both the end\_at timestamp and the time\_left parameter.                                                                                               |

</details>

<details>

<summary><strong>Quizzes</strong> (13 endpoints)</summary>

| Scope                                                                   | Description                                                                                                                              |
| ----------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| `url:GET\|/api/quiz/v1/courses/:course_id/quizzes`                      | Get a list of new quizzes.                                                                                                               |
| `url:POST\|/api/quiz/v1/courses/:course_id/quizzes`                     | Create a new quiz for the course.                                                                                                        |
| `url:DELETE\|/api/quiz/v1/courses/:course_id/quizzes/:assignment_id`    | Delete a single new quiz.                                                                                                                |
| `url:GET\|/api/quiz/v1/courses/:course_id/quizzes/:assignment_id`       | Get details about a single new quiz.                                                                                                     |
| `url:PATCH\|/api/quiz/v1/courses/:course_id/quizzes/:assignment_id`     | Update a single quiz for the course.                                                                                                     |
| `url:GET\|/api/v1/courses/:course_id/all_quizzes`                       | Returns the paginated list of Quizzes in this course.                                                                                    |
| `url:GET\|/api/v1/courses/:course_id/quizzes`                           | Returns the paginated list of Quizzes in this course.                                                                                    |
| `url:POST\|/api/v1/courses/:course_id/quizzes`                          | Create a new quiz for this course.                                                                                                       |
| `url:DELETE\|/api/v1/courses/:course_id/quizzes/:id`                    | Deletes a quiz and returns the deleted quiz object.                                                                                      |
| `url:GET\|/api/v1/courses/:course_id/quizzes/:id`                       | Returns the quiz with the given id.                                                                                                      |
| `url:PUT\|/api/v1/courses/:course_id/quizzes/:id`                       | Modify an existing quiz.                                                                                                                 |
| `url:POST\|/api/v1/courses/:course_id/quizzes/:id/reorder`              | Change order of the quiz questions or groups within the quiz **204 No Content** response code is returned if the reorder was successful. |
| `url:POST\|/api/v1/courses/:course_id/quizzes/:id/validate_access_code` | Accepts an access code and returns a boolean indicating whether that access code is correct                                              |

</details>

<details>

<summary><strong>Result</strong> (1 endpoint)</summary>

| Scope                                                                         | Description                                         |
| ----------------------------------------------------------------------------- | --------------------------------------------------- |
| `url:GET\|/api/v1/courses/:course_id/live_assessments/:assessment_id/results` | Returns a paginated list of live assessment results |

</details>

<details>

<summary><strong>Roles</strong> (9 endpoints)</summary>

| Scope                                                         | Description                                                                                                                                                                                                                     |
| ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `url:GET\|/api/v1/accounts/:account_id/roles`                 | A paginated list of the roles available to an account.                                                                                                                                                                          |
| `url:POST\|/api/v1/accounts/:account_id/roles`                | Create a new course-level or account-level role.                                                                                                                                                                                |
| `url:DELETE\|/api/v1/accounts/:account_id/roles/:id`          | Deactivates a custom role.                                                                                                                                                                                                      |
| `url:GET\|/api/v1/accounts/:account_id/roles/:id`             | Retrieve information about a single role                                                                                                                                                                                        |
| `url:PUT\|/api/v1/accounts/:account_id/roles/:id`             | Update permissions for an existing role.                                                                                                                                                                                        |
| `url:POST\|/api/v1/accounts/:account_id/roles/:id/activate`   | Re-activates an inactive role (allowing it to be assigned to new users)                                                                                                                                                         |
| `url:GET\|/api/v1/accounts/:account_id/roles/permissions`     | List all permissions that can be granted to roles in the given account.                                                                                                                                                         |
| `url:GET\|/api/v1/permissions/:context_type/:permission/help` | 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. |
| `url:GET\|/api/v1/permissions/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.                                                          |

</details>

<details>

<summary><strong>Rubrics</strong> (20 endpoints)</summary>

| Scope                                                                                                      | Description                                                                              |
| ---------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| `url:GET\|/api/v1/accounts/:account_id/rubrics`                                                            | Returns the paginated list of active rubrics for the current context.                    |
| `url:GET\|/api/v1/accounts/:account_id/rubrics/:id`                                                        | Returns the rubric with the given id.                                                    |
| `url:GET\|/api/v1/accounts/:account_id/rubrics/:id/used_locations`                                         | Returns the courses and assignments where a rubric is being used                         |
| `url:POST\|/api/v1/accounts/:account_id/rubrics/upload`                                                    | Returns the rubric import object that was created                                        |
| `url:GET\|/api/v1/accounts/:account_id/rubrics/upload/:id`                                                 | Can return the latest rubric import for an account or course, or a specific import by id |
| `url:POST\|/api/v1/courses/:course_id/rubric_associations`                                                 | Returns the rubric with the given id.                                                    |
| `url:DELETE\|/api/v1/courses/:course_id/rubric_associations/:id`                                           | Delete the RubricAssociation with the given ID                                           |
| `url:PUT\|/api/v1/courses/:course_id/rubric_associations/:id`                                              | Returns the rubric with the given id.                                                    |
| `url:POST\|/api/v1/courses/:course_id/rubric_associations/:rubric_association_id/rubric_assessments`       | Returns the rubric assessment with the given id.                                         |
| `url:DELETE\|/api/v1/courses/:course_id/rubric_associations/:rubric_association_id/rubric_assessments/:id` | Deletes a rubric assessment                                                              |
| `url:PUT\|/api/v1/courses/:course_id/rubric_associations/:rubric_association_id/rubric_assessments/:id`    | Returns the rubric assessment with the given id.                                         |
| `url:GET\|/api/v1/courses/:course_id/rubrics`                                                              | Returns the paginated list of active rubrics for the current context.                    |
| `url:POST\|/api/v1/courses/:course_id/rubrics`                                                             | Returns the rubric with the given id.                                                    |
| `url:DELETE\|/api/v1/courses/:course_id/rubrics/:id`                                                       | Deletes a Rubric and removes all RubricAssociations.                                     |
| `url:GET\|/api/v1/courses/:course_id/rubrics/:id`                                                          | Returns the rubric with the given id.                                                    |
| `url:PUT\|/api/v1/courses/:course_id/rubrics/:id`                                                          | Returns the rubric with the given id.                                                    |
| `url:GET\|/api/v1/courses/:course_id/rubrics/:id/used_locations`                                           | Returns the courses and assignments where a rubric is being used                         |
| `url:POST\|/api/v1/courses/:course_id/rubrics/upload`                                                      | Returns the rubric import object that was created                                        |
| `url:GET\|/api/v1/courses/:course_id/rubrics/upload/:id`                                                   | Can return the latest rubric import for an account or course, or a specific import by id |
| `url:GET\|/api/v1/rubrics/upload_template`                                                                 | Returns a CSV template file that can be used to import rubrics into Canvas.              |

</details>

<details>

<summary><strong>SIS Import Errors</strong> (2 endpoints)</summary>

| Scope                                                          | Description                                                           |
| -------------------------------------------------------------- | --------------------------------------------------------------------- |
| `url:GET\|/api/v1/accounts/:account_id/sis_import_errors`      | Returns the list of SIS import errors for an account or a SIS import. |
| `url:GET\|/api/v1/accounts/:account_id/sis_imports/:id/errors` | Returns the list of SIS import errors for an account or a SIS import. |

</details>

<details>

<summary><strong>SIS Imports</strong> (7 endpoints)</summary>

| Scope                                                                  | Description                                                                                                                                                       |
| ---------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `url:GET\|/api/v1/accounts/:account_id/sis_imports`                    | Returns the list of SIS imports for an account Example: curl https\://\<canvas>/api/v1/accounts/\<account\_id>/sis\_imports \ -H 'Authorization: Bearer \<token>' |
| `url:POST\|/api/v1/accounts/:account_id/sis_imports`                   | Import SIS data into Canvas.                                                                                                                                      |
| `url:GET\|/api/v1/accounts/:account_id/sis_imports/:id`                | Get the status of an already created SIS import.                                                                                                                  |
| `url:PUT\|/api/v1/accounts/:account_id/sis_imports/:id/abort`          | Abort a SIS import that has not completed.                                                                                                                        |
| `url:PUT\|/api/v1/accounts/:account_id/sis_imports/:id/restore_states` | This will restore the the workflow\_state for all the items that changed their workflow\_state during the import being restored.                                  |
| `url:PUT\|/api/v1/accounts/:account_id/sis_imports/abort_all_pending`  | Abort already created but not processed or processing SIS imports.                                                                                                |
| `url:GET\|/api/v1/accounts/:account_id/sis_imports/importing`          | Returns the SIS imports that are currently processing for an account.                                                                                             |

</details>

<details>

<summary><strong>SIS Integration</strong> (3 endpoints)</summary>

| Scope                                                      | Description                                                                                                                 |
| ---------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
| `url:GET\|/api/sis/accounts/:account_id/assignments`       | Retrieve a list of published assignments flagged as "post\_to\_sis".                                                        |
| `url:GET\|/api/sis/courses/:course_id/assignments`         | Retrieve a list of published assignments flagged as "post\_to\_sis".                                                        |
| `url:PUT\|/api/sis/courses/:course_id/disable_post_to_sis` | Disable all assignments flagged as "post\_to\_sis", with the option of making it specific to a grading period, in a course. |

</details>

<details>

<summary><strong>Search</strong> (3 endpoints)</summary>

| Scope                                            | Description                                                                                   |
| ------------------------------------------------ | --------------------------------------------------------------------------------------------- |
| `url:GET\|/api/v1/conversations/find_recipients` | Find valid recipients (users, courses and groups) that the current user can send messages to. |
| `url:GET\|/api/v1/search/all_courses`            | A paginated list of all courses visible in the public index                                   |
| `url:GET\|/api/v1/search/recipients`             | Find valid recipients (users, courses and groups) that the current user can send messages to. |

</details>

<details>

<summary><strong>Sections</strong> (9 endpoints)</summary>

| Scope                                                     | Description                                                           |
| --------------------------------------------------------- | --------------------------------------------------------------------- |
| `url:GET\|/api/v1/courses/:course_id/sections`            | A paginated list of the list of sections for this course.             |
| `url:POST\|/api/v1/courses/:course_id/sections`           | Creates a new section for this course.                                |
| `url:GET\|/api/v1/courses/:course_id/sections/:id`        | Gets details about a specific section                                 |
| `url:DELETE\|/api/v1/sections/:id`                        | Delete an existing section.                                           |
| `url:GET\|/api/v1/sections/:id`                           | Gets details about a specific section                                 |
| `url:PUT\|/api/v1/sections/:id`                           | Modify an existing section.                                           |
| `url:DELETE\|/api/v1/sections/:id/crosslist`              | Undo cross-listing of a Section, returning it to its original course. |
| `url:POST\|/api/v1/sections/:id/crosslist/:new_course_id` | Move the Section to another course.                                   |
| `url:GET\|/api/v1/sections/:id/users`                     | Returns a paginated list of users in the section.                     |

</details>

<details>

<summary><strong>Services</strong> (2 endpoints)</summary>

| Scope                                        | Description                                                                                                             |
| -------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------- |
| `url:GET\|/api/v1/services/kaltura`          | Return the config information for the Kaltura plugin in json format.                                                    |
| `url:POST\|/api/v1/services/kaltura_session` | Start a new Kaltura session, so that new media can be recorded and uploaded to this Canvas instance's Kaltura instance. |

</details>

<details>

<summary><strong>Shared Brand Configs</strong> (3 endpoints)</summary>

| Scope                                                            | Description                                                                                                                      |
| ---------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| `url:POST\|/api/v1/accounts/:account_id/shared_brand_configs`    | Create a SharedBrandConfig, which will give the given brand\_config a name and make it available to other users of this account. |
| `url:PUT\|/api/v1/accounts/:account_id/shared_brand_configs/:id` | Update the specified shared\_brand\_config with a new name or to point to a new brand\_config.                                   |
| `url:DELETE\|/api/v1/shared_brand_configs/:id`                   | Delete a SharedBrandConfig, which will unshare it so you nor anyone else in your account will see it as an option to pick from.  |

</details>

<details>

<summary><strong>Smart Search</strong> (1 endpoint)</summary>

| Scope                                             | Description                                      |
| ------------------------------------------------- | ------------------------------------------------ |
| `url:GET\|/api/v1/courses/:course_id/smartsearch` | Find course content using a meaning-based search |

</details>

<details>

<summary><strong>Study Assist</strong> (1 endpoint)</summary>

| Scope                                               | Description |
| --------------------------------------------------- | ----------- |
| `url:POST\|/api/v1/courses/:course_id/study_assist` |             |

</details>

<details>

<summary><strong>Submission Comments</strong> (4 endpoints)</summary>

| Scope                                                                                                          | Description                                                                                                                    |
| -------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ |
| `url:POST\|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id/annotation_notification` | Send notification of annotation to other users of the submission Must have permission to send\_messages on Site Admin account. |
| `url:DELETE\|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id/comments/:id`          | Delete the given submission comment.                                                                                           |
| `url:PUT\|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id/comments/:id`             | Edit the given submission comment.                                                                                             |
| `url:POST\|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id/comments/files`          | Upload a file to attach to a submission comment See the {file:file.                                                            |

</details>

<details>

<summary><strong>Submissions</strong> (46 endpoints)</summary>

| Scope                                                                                                             | Description                                                                                                                                              |
| ----------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `url:GET\|/api/v1/courses/:course_id/assignments/:assignment_id/anonymous_submissions/:anonymous_id`              | Get a single submission, based on the submission's anonymous id.                                                                                         |
| `url:PUT\|/api/v1/courses/:course_id/assignments/:assignment_id/anonymous_submissions/: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).                |
| `url:GET\|/api/v1/courses/:course_id/assignments/:assignment_id/gradeable_students`                               | A paginated list of gradeable students for the assignment.                                                                                               |
| `url:GET\|/api/v1/courses/:course_id/assignments/:assignment_id/submission_summary`                               | Returns the number of submissions for the given assignment based on gradeable students that fall into three categories: graded, ungraded, not submitted. |
| `url:GET\|/api/v1/courses/:course_id/assignments/:assignment_id/submissions`                                      | A paginated list of all existing submissions for an assignment.                                                                                          |
| `url:POST\|/api/v1/courses/:course_id/assignments/:assignment_id/submissions`                                     | Make a submission for an assignment.                                                                                                                     |
| `url:GET\|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id`                             | Get a single submission, based on user id.                                                                                                               |
| `url:PUT\|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id`                             | Comment on and/or update the grading for a student's assignment submission.                                                                              |
| `url:GET\|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id/document_annotations/read`   | Return whether annotations made on a submitted document have been read by the student                                                                    |
| `url:PUT\|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id/document_annotations/read`   | Indicate that annotations made on a submitted document have been read by the student.                                                                    |
| `url:POST\|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id/files`                      | Upload a file to a submission.                                                                                                                           |
| `url:DELETE\|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id/read`                     | No request fields are necessary.                                                                                                                         |
| `url:PUT\|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id/read`                        | No request fields are necessary.                                                                                                                         |
| `url:PUT\|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id/read/:item`                  | No request fields are necessary.                                                                                                                         |
| `url:GET\|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id/rubric_assessments/read`     | Return whether new rubric comments/grading made on a submission have been seen by the student being assessed.                                            |
| `url:PUT\|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id/rubric_assessments/read`     | Indicate that rubric comments/grading made on a submission have been read by the student being assessed.                                                 |
| `url:GET\|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id/rubric_comments/read`        | Return whether new rubric comments/grading made on a submission have been seen by the student being assessed.                                            |
| `url:PUT\|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id/rubric_comments/read`        | Indicate that rubric comments/grading made on a submission have been read by the student being assessed.                                                 |
| `url:POST\|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/update_grades`                       | Update the grading and comments on multiple student's assignment submissions in an asynchronous job.                                                     |
| `url:GET\|/api/v1/courses/:course_id/assignments/gradeable_students`                                              | A paginated list of students eligible to submit a list of assignments.                                                                                   |
| `url:GET\|/api/v1/courses/:course_id/students/submissions`                                                        | A paginated list of all existing submissions for a given set of students and assignments.                                                                |
| `url:PUT\|/api/v1/courses/:course_id/submissions/:user_id/clear_unread`                                           | Site-admin-only endpoint.                                                                                                                                |
| `url:PUT\|/api/v1/courses/:course_id/submissions/bulk_mark_read`                                                  | Accepts a string array of submission ids.                                                                                                                |
| `url:POST\|/api/v1/courses/:course_id/submissions/update_grades`                                                  | Update the grading and comments on multiple student's assignment submissions in an asynchronous job.                                                     |
| `url:GET\|/api/v1/sections/:section_id/assignments/:assignment_id/anonymous_submissions/:anonymous_id`            | Get a single submission, based on the submission's anonymous id.                                                                                         |
| `url:PUT\|/api/v1/sections/:section_id/assignments/:assignment_id/anonymous_submissions/: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).                |
| `url:GET\|/api/v1/sections/:section_id/assignments/:assignment_id/submission_summary`                             | Returns the number of submissions for the given assignment based on gradeable students that fall into three categories: graded, ungraded, not submitted. |
| `url:GET\|/api/v1/sections/:section_id/assignments/:assignment_id/submissions`                                    | A paginated list of all existing submissions for an assignment.                                                                                          |
| `url:POST\|/api/v1/sections/:section_id/assignments/:assignment_id/submissions`                                   | Make a submission for an assignment.                                                                                                                     |
| `url:GET\|/api/v1/sections/:section_id/assignments/:assignment_id/submissions/:user_id`                           | Get a single submission, based on user id.                                                                                                               |
| `url:PUT\|/api/v1/sections/:section_id/assignments/:assignment_id/submissions/:user_id`                           | Comment on and/or update the grading for a student's assignment submission.                                                                              |
| `url:GET\|/api/v1/sections/:section_id/assignments/:assignment_id/submissions/:user_id/document_annotations/read` | Return whether annotations made on a submitted document have been read by the student                                                                    |
| `url:PUT\|/api/v1/sections/:section_id/assignments/:assignment_id/submissions/:user_id/document_annotations/read` | Indicate that annotations made on a submitted document have been read by the student.                                                                    |
| `url:POST\|/api/v1/sections/:section_id/assignments/:assignment_id/submissions/:user_id/files`                    | Upload a file to a submission.                                                                                                                           |
| `url:DELETE\|/api/v1/sections/:section_id/assignments/:assignment_id/submissions/:user_id/read`                   | No request fields are necessary.                                                                                                                         |
| `url:PUT\|/api/v1/sections/:section_id/assignments/:assignment_id/submissions/:user_id/read`                      | No request fields are necessary.                                                                                                                         |
| `url:PUT\|/api/v1/sections/:section_id/assignments/:assignment_id/submissions/:user_id/read/:item`                | No request fields are necessary.                                                                                                                         |
| `url:GET\|/api/v1/sections/:section_id/assignments/:assignment_id/submissions/:user_id/rubric_assessments/read`   | Return whether new rubric comments/grading made on a submission have been seen by the student being assessed.                                            |
| `url:PUT\|/api/v1/sections/:section_id/assignments/:assignment_id/submissions/:user_id/rubric_assessments/read`   | Indicate that rubric comments/grading made on a submission have been read by the student being assessed.                                                 |
| `url:GET\|/api/v1/sections/:section_id/assignments/:assignment_id/submissions/:user_id/rubric_comments/read`      | Return whether new rubric comments/grading made on a submission have been seen by the student being assessed.                                            |
| `url:PUT\|/api/v1/sections/:section_id/assignments/:assignment_id/submissions/:user_id/rubric_comments/read`      | Indicate that rubric comments/grading made on a submission have been read by the student being assessed.                                                 |
| `url:POST\|/api/v1/sections/:section_id/assignments/:assignment_id/submissions/update_grades`                     | Update the grading and comments on multiple student's assignment submissions in an asynchronous job.                                                     |
| `url:GET\|/api/v1/sections/:section_id/students/submissions`                                                      | A paginated list of all existing submissions for a given set of students and assignments.                                                                |
| `url:PUT\|/api/v1/sections/:section_id/submissions/:user_id/clear_unread`                                         | Site-admin-only endpoint.                                                                                                                                |
| `url:PUT\|/api/v1/sections/:section_id/submissions/bulk_mark_read`                                                | Accepts a string array of submission ids.                                                                                                                |
| `url:POST\|/api/v1/sections/:section_id/submissions/update_grades`                                                | Update the grading and comments on multiple student's assignment submissions in an asynchronous job.                                                     |

</details>

<details>

<summary><strong>Tabs</strong> (5 endpoints)</summary>

| Scope                                              | Description                                                                                  |
| -------------------------------------------------- | -------------------------------------------------------------------------------------------- |
| `url:GET\|/api/v1/accounts/:account_id/tabs`       | Returns a list of navigation tabs available in the current context.                          |
| `url:GET\|/api/v1/courses/:course_id/tabs`         | Returns a list of navigation tabs available in the current context.                          |
| `url:PUT\|/api/v1/courses/:course_id/tabs/:tab_id` | Home and Settings tabs are not manageable, and can't be hidden or moved Returns a tab object |
| `url:GET\|/api/v1/groups/:group_id/tabs`           | Returns a list of navigation tabs available in the current context.                          |
| `url:GET\|/api/v1/users/:user_id/tabs`             | Returns a list of navigation tabs available in the current context.                          |

</details>

<details>

<summary><strong>Temporary Enrollment Pairings</strong> (5 endpoints)</summary>

| Scope                                                                        | Description                                                                                     |
| ---------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- |
| `url:GET\|/api/v1/accounts/:account_id/temporary_enrollment_pairings`        | Returns the list of temporary enrollment pairings for a root account, ordered by creation time. |
| `url:POST\|/api/v1/accounts/:account_id/temporary_enrollment_pairings`       | Create a Temporary Enrollment Pairing.                                                          |
| `url:DELETE\|/api/v1/accounts/:account_id/temporary_enrollment_pairings/:id` | Delete a temporary enrollment pairing                                                           |
| `url:GET\|/api/v1/accounts/:account_id/temporary_enrollment_pairings/:id`    | Returns the temporary enrollment pairing with the given id.                                     |
| `url:GET\|/api/v1/accounts/:account_id/temporary_enrollment_pairings/new`    | Initialize an unsaved Temporary Enrollment Pairing.                                             |

</details>

<details>

<summary><strong>User Observees</strong> (8 endpoints)</summary>

| Scope                                                       | Description                                                                                                                              |
| ----------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| `url:GET\|/api/v1/users/:user_id/observees`                 | A paginated list of users that the given user is observing.                                                                              |
| `url:POST\|/api/v1/users/:user_id/observees`                | Register the given user to observe another user, given the observee's credentials.                                                       |
| `url:DELETE\|/api/v1/users/:user_id/observees/:observee_id` | Unregisters a user as being observed by the given user.                                                                                  |
| `url:GET\|/api/v1/users/:user_id/observees/:observee_id`    | Gets information about an observed user.                                                                                                 |
| `url:PUT\|/api/v1/users/:user_id/observees/:observee_id`    | Registers a user as being observed by the given user.                                                                                    |
| `url:POST\|/api/v1/users/:user_id/observer_pairing_codes`   | 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. |
| `url:GET\|/api/v1/users/:user_id/observers`                 | A paginated list of observers linked to a given user.                                                                                    |
| `url:GET\|/api/v1/users/:user_id/observers/:observer_id`    | Gets information about an observer.                                                                                                      |

</details>

<details>

<summary><strong>Users</strong> (48 endpoints)</summary>

| Scope                                                                                               | Description                                                                                                                               |
| --------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| `url:POST\|/api/v1/accounts/:account_id/self_registration`                                          | Self register and return a new user and pseudonym for an account.                                                                         |
| `url:GET\|/api/v1/accounts/:account_id/users`                                                       | A paginated list of users associated with this account.                                                                                   |
| `url:POST\|/api/v1/accounts/:account_id/users`                                                      | Create and return a new user and pseudonym for an account.                                                                                |
| `url:GET\|/api/v1/users/:id`                                                                        | Shows details for user.                                                                                                                   |
| `url:PUT\|/api/v1/users/:id`                                                                        | Modify an existing user.                                                                                                                  |
| `url:GET\|/api/v1/users/:id/colors`                                                                 | Returns all custom colors that have been saved for a user.                                                                                |
| `url:GET\|/api/v1/users/:id/colors/:asset_string`                                                   | Returns the custom colors that have been saved for a user for a given context.                                                            |
| `url:PUT\|/api/v1/users/:id/colors/:asset_string`                                                   | Updates a custom color for a user for a given context.                                                                                    |
| `url:GET\|/api/v1/users/:id/dashboard_positions`                                                    | Returns all dashboard positions that have been saved for a user.                                                                          |
| `url:PUT\|/api/v1/users/:id/dashboard_positions`                                                    | Updates the dashboard positions for a user for a given context.                                                                           |
| `url:PUT\|/api/v1/users/:id/files_ui_version_preference`                                            | Updates a user's default choice for files UI version.                                                                                     |
| `url:GET\|/api/v1/users/:id/graded_submissions`                                                     | Returns a list of the user's most recently graded submissions.                                                                            |
| `url:PUT\|/api/v1/users/:id/merge_into/:destination_user_id`                                        | Merge a user into another user.                                                                                                           |
| `url:PUT\|/api/v1/users/:id/merge_into/accounts/:destination_account_id/users/:destination_user_id` | Merge a user into another user.                                                                                                           |
| `url:DELETE\|/api/v1/users/:id/mobile_sessions`                                                     | Permanently expires any active mobile sessions, forcing them to re-authorize.                                                             |
| `url:DELETE\|/api/v1/users/:id/sessions`                                                            | Terminates all sessions for a user.                                                                                                       |
| `url:GET\|/api/v1/users/:id/settings`                                                               | Update an existing user's settings.                                                                                                       |
| `url:POST\|/api/v1/users/:id/split`                                                                 | Merged users cannot be fully restored to their previous state, but this will attempt to split as much as possible to the previous state.  |
| `url:PUT\|/api/v1/users/:id/text_editor_preference`                                                 | Updates a user's default choice for text editor.                                                                                          |
| `url:GET\|/api/v1/users/:user_id/avatars`                                                           | A paginated list of the possible user avatar options that can be set with the user update endpoint.                                       |
| `url:DELETE\|/api/v1/users/:user_id/custom_data(/*scope)`                                           | Delete custom user data.                                                                                                                  |
| `url:GET\|/api/v1/users/:user_id/custom_data(/*scope)`                                              | Load custom user data.                                                                                                                    |
| `url:PUT\|/api/v1/users/:user_id/custom_data(/*scope)`                                              | Store arbitrary user data as JSON.                                                                                                        |
| `url:POST\|/api/v1/users/:user_id/files`                                                            | Upload a file to the user's personal files section.                                                                                       |
| `url:GET\|/api/v1/users/:user_id/missing_submissions`                                               | A paginated list of past-due assignments for which the student does not have a submission.                                                |
| `url:GET\|/api/v1/users/:user_id/page_views`                                                        | Return a paginated list of the user's page view history in json format, similar to the available CSV download.                            |
| `url:POST\|/api/v1/users/:user_id/page_views/query`                                                 | Initiates an asynchronous query for user page views data within a specified date range.                                                   |
| `url:GET\|/api/v1/users/:user_id/page_views/query/:query_id`                                        | Checks the status of a previously initiated page views query.                                                                             |
| `url:GET\|/api/v1/users/:user_id/page_views/query/:query_id/results`                                | Retrieves the results of a completed page views query.                                                                                    |
| `url:GET\|/api/v1/users/:user_id/profile`                                                           | Returns user profile data, including user id, name, and profile pic.                                                                      |
| `url:GET\|/api/v1/users/activity_stream`                                                            | Returns the current user's global activity stream, paginated.                                                                             |
| `url:DELETE\|/api/v1/users/mobile_sessions`                                                         | Permanently expires any active mobile sessions, forcing them to re-authorize.                                                             |
| `url:POST\|/api/v1/users/page_views/query`                                                          | Initiates an asynchronous query for page views data across multiple users.                                                                |
| `url:GET\|/api/v1/users/page_views/query/:query_id`                                                 | Checks the status of a previously initiated batch page views query.                                                                       |
| `url:GET\|/api/v1/users/page_views/query/:query_id/results`                                         | Retrieves the results of a completed batch page views query.                                                                              |
| `url:DELETE\|/api/v1/users/self/activity_stream`                                                    | Hide all stream items for the user                                                                                                        |
| `url:GET\|/api/v1/users/self/activity_stream`                                                       | Returns the current user's global activity stream, paginated.                                                                             |
| `url:DELETE\|/api/v1/users/self/activity_stream/:id`                                                | Hide the given stream item.                                                                                                               |
| `url:GET\|/api/v1/users/self/activity_stream/summary`                                               | Returns a summary of the current user's global activity stream.                                                                           |
| `url:DELETE\|/api/v1/users/self/course_nicknames`                                                   | Remove all stored course nicknames.                                                                                                       |
| `url:GET\|/api/v1/users/self/course_nicknames`                                                      | Returns all course nicknames you have set.                                                                                                |
| `url:DELETE\|/api/v1/users/self/course_nicknames/:course_id`                                        | Remove the nickname for the given course.                                                                                                 |
| `url:GET\|/api/v1/users/self/course_nicknames/:course_id`                                           | Returns the nickname for a specific course.                                                                                               |
| `url:PUT\|/api/v1/users/self/course_nicknames/:course_id`                                           | Set a nickname for the given course.                                                                                                      |
| `url:POST\|/api/v1/users/self/pandata_events_token`                                                 | Returns a jwt auth and props token that can be used to send events to Pandata.                                                            |
| `url:GET\|/api/v1/users/self/todo`                                                                  | A paginated list of the current user's list of todo items.                                                                                |
| `url:GET\|/api/v1/users/self/todo_item_count`                                                       | Counts of different todo items such as the number of assignments needing grading as well as the number of assignments needing submitting. |
| `url:GET\|/api/v1/users/self/upcoming_events`                                                       | A paginated list of the current user's upcoming events.                                                                                   |

</details>

<details>

<summary><strong>What If Grades</strong> (2 endpoints)</summary>

| Scope                                                      | Description                                                                                                                                            |
| ---------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `url:PUT\|/api/v1/courses/:course_id/what_if_grades/reset` | Resets all what-if scores for a student in a course and recalculates grades.                                                                           |
| `url:PUT\|/api/v1/submissions/:id/what_if_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 |

</details>

<details>

<summary><strong>ePortfolios</strong> (7 endpoints)</summary>

| Scope                                                  | Description                                                       |
| ------------------------------------------------------ | ----------------------------------------------------------------- |
| `url:PUT\|/api/v1/eportfolios/:eportfolio_id/moderate` | Update the spam\_status of an eportfolio.                         |
| `url:GET\|/api/v1/eportfolios/:eportfolio_id/pages`    | Get details for the pages of an ePortfolio                        |
| `url:PUT\|/api/v1/eportfolios/:eportfolio_id/restore`  | Restore an ePortfolio back to active that was previously deleted. |
| `url:DELETE\|/api/v1/eportfolios/:id`                  | Mark an ePortfolio as deleted.                                    |
| `url:GET\|/api/v1/eportfolios/:id`                     | Get details for a single ePortfolio.                              |
| `url:GET\|/api/v1/users/:user_id/eportfolios`          | Get a list of all ePortfolios for the specified user.             |
| `url:PUT\|/api/v1/users/:user_id/eportfolios`          | Update the spam\_status for all active eportfolios of a user.     |

</details>

<details>

<summary><strong>ePub Exports</strong> (3 endpoints)</summary>

| Scope                                                  | Description                                                                                                                        |
| ------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------- |
| `url:POST\|/api/v1/courses/:course_id/epub_exports`    | Begin an ePub export for a course.                                                                                                 |
| `url:GET\|/api/v1/courses/:course_id/epub_exports/:id` | Get information about a single ePub export.                                                                                        |
| `url:GET\|/api/v1/epub_exports`                        | A paginated list of all courses a user is actively participating in, and the latest ePub export associated with the user & course. |

</details>

## Using Scopes

### For Developer Keys

When creating a developer key in Canvas:

1. Go to Account → Settings → Developer Keys
2. Create or edit a key
3. Enable scope configuration
4. Select the scopes your application needs

### For Access Tokens

Access tokens inherit the scopes from their associated developer key. Personal access tokens have access to all scopes the user has permissions for.

### API Endpoint

You can retrieve the list of scopes programmatically:

```
GET /api/v1/accounts/:account_id/scopes
```

See the [API Token Scopes API](https://developerdocs.instructure.com/services/canvas/resources/api_token_scopes.md) documentation for details.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://developerdocs.instructure.com/services/canvas/oauth2/file.scopes.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
