Api Token Scopes
Below is a list of all API token scopes (See here). Scopes may also be found beneath their corresponding endpoints in the "resources" documentation pages.
Account Notifications
Verb | Endpoint | Scope |
---|---|---|
POST | /api/v1/accounts/:account_id/account_notifications | url:POST|/api/v1/accounts/:account_id/account_notifications |
PUT | /api/v1/accounts/:account_id/account_notifications/:id | url:PUT|/api/v1/accounts/:account_id/account_notifications/:id |
GET | /api/v1/accounts/:account_id/account_notifications | url:GET|/api/v1/accounts/:account_id/account_notifications |
GET | /api/v1/accounts/:account_id/account_notifications/:id | url:GET|/api/v1/accounts/:account_id/account_notifications/:id |
DELETE | /api/v1/accounts/:account_id/account_notifications/:id | url:DELETE|/api/v1/accounts/:account_id/account_notifications/:id |
Account Reports
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/accounts/:account_id/reports/:report | url:GET|/api/v1/accounts/:account_id/reports/:report |
GET | /api/v1/accounts/:account_id/reports | url:GET|/api/v1/accounts/:account_id/reports |
GET | /api/v1/accounts/:account_id/reports/:report/:id | url:GET|/api/v1/accounts/:account_id/reports/:report/:id |
POST | /api/v1/accounts/:account_id/reports/:report | url:POST|/api/v1/accounts/:account_id/reports/:report |
DELETE | /api/v1/accounts/:account_id/reports/:report/:id | url:DELETE|/api/v1/accounts/:account_id/reports/:report/:id |
Accounts
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/accounts | url:GET|/api/v1/accounts |
GET | /api/v1/course_accounts | url:GET|/api/v1/course_accounts |
GET | /api/v1/accounts/:id | url:GET|/api/v1/accounts/:id |
PUT | /api/v1/accounts/:id | url:PUT|/api/v1/accounts/:id |
GET | /api/v1/accounts/:account_id/terms_of_service | url:GET|/api/v1/accounts/:account_id/terms_of_service |
GET | /api/v1/accounts/:account_id/courses | url:GET|/api/v1/accounts/:account_id/courses |
GET | /api/v1/accounts/:account_id/sub_accounts | url:GET|/api/v1/accounts/:account_id/sub_accounts |
GET | /api/v1/accounts/:account_id/permissions | url:GET|/api/v1/accounts/:account_id/permissions |
DELETE | /api/v1/accounts/:account_id/users/:user_id | url:DELETE|/api/v1/accounts/:account_id/users/:user_id |
POST | /api/v1/accounts/:account_id/sub_accounts | url:POST|/api/v1/accounts/:account_id/sub_accounts |
DELETE | /api/v1/accounts/:account_id/sub_accounts/:id | url:DELETE|/api/v1/accounts/:account_id/sub_accounts/:id |
Admins
Verb | Endpoint | Scope |
---|---|---|
POST | /api/v1/accounts/:account_id/admins | url:POST|/api/v1/accounts/:account_id/admins |
DELETE | /api/v1/accounts/:account_id/admins/:user_id | url:DELETE|/api/v1/accounts/:account_id/admins/:user_id |
GET | /api/v1/accounts/:account_id/admins | url:GET|/api/v1/accounts/:account_id/admins |
Announcement External Feeds
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/courses/:course_id/external_feeds | url:GET|/api/v1/courses/:course_id/external_feeds |
POST | /api/v1/courses/:course_id/external_feeds | url:POST|/api/v1/courses/:course_id/external_feeds |
DELETE | /api/v1/courses/:course_id/external_feeds/:external_feed_id | url:DELETE|/api/v1/courses/:course_id/external_feeds/:external_feed_id |
GET | /api/v1/groups/:group_id/external_feeds | url:GET|/api/v1/groups/:group_id/external_feeds |
POST | /api/v1/groups/:group_id/external_feeds | url:POST|/api/v1/groups/:group_id/external_feeds |
DELETE | /api/v1/groups/:group_id/external_feeds/:external_feed_id | url:DELETE|/api/v1/groups/:group_id/external_feeds/:external_feed_id |
Announcements
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/announcements | url:GET|/api/v1/announcements |
Appointment Groups
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/appointment_groups | url:GET|/api/v1/appointment_groups |
POST | /api/v1/appointment_groups | url:POST|/api/v1/appointment_groups |
GET | /api/v1/appointment_groups/next_appointment | url:GET|/api/v1/appointment_groups/next_appointment |
GET | /api/v1/appointment_groups/:id | url:GET|/api/v1/appointment_groups/:id |
PUT | /api/v1/appointment_groups/:id | url:PUT|/api/v1/appointment_groups/:id |
DELETE | /api/v1/appointment_groups/:id | url:DELETE|/api/v1/appointment_groups/:id |
GET | /api/v1/appointment_groups/:id/users | url:GET|/api/v1/appointment_groups/:id/users |
GET | /api/v1/appointment_groups/:id/groups | url:GET|/api/v1/appointment_groups/:id/groups |
Assignment Groups
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/courses/:course_id/assignment_groups | url:GET|/api/v1/courses/:course_id/assignment_groups |
GET | /api/v1/courses/:course_id/assignment_groups/:assignment_group_id | url:GET|/api/v1/courses/:course_id/assignment_groups/:assignment_group_id |
POST | /api/v1/courses/:course_id/assignment_groups | url:POST|/api/v1/courses/:course_id/assignment_groups |
PUT | /api/v1/courses/:course_id/assignment_groups/:assignment_group_id | url:PUT|/api/v1/courses/:course_id/assignment_groups/:assignment_group_id |
DELETE | /api/v1/courses/:course_id/assignment_groups/:assignment_group_id | url:DELETE|/api/v1/courses/:course_id/assignment_groups/:assignment_group_id |
Assignments
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/courses/:course_id/assignments/:assignment_id/overrides | url:GET|/api/v1/courses/:course_id/assignments/:assignment_id/overrides |
POST | /api/v1/courses/:course_id/assignments/:assignment_id/overrides | url:POST|/api/v1/courses/:course_id/assignments/:assignment_id/overrides |
GET | /api/v1/courses/:course_id/assignments/:assignment_id/overrides/:id | url:GET|/api/v1/courses/:course_id/assignments/:assignment_id/overrides/:id |
PUT | /api/v1/courses/:course_id/assignments/:assignment_id/overrides/:id | url:PUT|/api/v1/courses/:course_id/assignments/:assignment_id/overrides/:id |
DELETE | /api/v1/courses/:course_id/assignments/:assignment_id/overrides/:id | url:DELETE|/api/v1/courses/:course_id/assignments/:assignment_id/overrides/:id |
GET | /api/v1/sections/:course_section_id/assignments/:assignment_id/override | url:GET|/api/v1/sections/:course_section_id/assignments/:assignment_id/override |
GET | /api/v1/groups/:group_id/assignments/:assignment_id/override | url:GET|/api/v1/groups/:group_id/assignments/:assignment_id/override |
GET | /api/v1/courses/:course_id/assignments/overrides | url:GET|/api/v1/courses/:course_id/assignments/overrides |
PUT | /api/v1/courses/:course_id/assignments/overrides | url:PUT|/api/v1/courses/:course_id/assignments/overrides |
POST | /api/v1/courses/:course_id/assignments/overrides | url:POST|/api/v1/courses/:course_id/assignments/overrides |
DELETE | /api/v1/courses/:course_id/assignments/:id | url:DELETE|/api/v1/courses/:course_id/assignments/:id |
Authentication Providers
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/accounts/:account_id/sso_settings | url:GET|/api/v1/accounts/:account_id/sso_settings |
PUT | /api/v1/accounts/:account_id/sso_settings | url:PUT|/api/v1/accounts/:account_id/sso_settings |
GET | /api/v1/accounts/:account_id/authentication_providers | url:GET|/api/v1/accounts/:account_id/authentication_providers |
GET | /api/v1/accounts/:account_id/authentication_providers/:id | url:GET|/api/v1/accounts/:account_id/authentication_providers/:id |
POST | /api/v1/accounts/:account_id/authentication_providers | url:POST|/api/v1/accounts/:account_id/authentication_providers |
PUT | /api/v1/accounts/:account_id/authentication_providers/:id | url:PUT|/api/v1/accounts/:account_id/authentication_providers/:id |
DELETE | /api/v1/accounts/:account_id/authentication_providers/:id | url:DELETE|/api/v1/accounts/:account_id/authentication_providers/:id |
Authentications Log
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/audit/authentication/logins/:login_id | url:GET|/api/v1/audit/authentication/logins/:login_id |
GET | /api/v1/audit/authentication/accounts/:account_id | url:GET|/api/v1/audit/authentication/accounts/:account_id |
GET | /api/v1/audit/authentication/users/:user_id | url:GET|/api/v1/audit/authentication/users/:user_id |
Brand Configs
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/brand_variables | url:GET|/api/v1/brand_variables |
Calendar Events
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/calendar_events | url:GET|/api/v1/calendar_events |
GET | /api/v1/users/:user_id/calendar_events | url:GET|/api/v1/users/:user_id/calendar_events |
POST | /api/v1/calendar_events | url:POST|/api/v1/calendar_events |
GET | /api/v1/calendar_events/:id | url:GET|/api/v1/calendar_events/:id |
PUT | /api/v1/calendar_events/:id | url:PUT|/api/v1/calendar_events/:id |
DELETE | /api/v1/calendar_events/:id | url:DELETE|/api/v1/calendar_events/:id |
POST | /api/v1/calendar_events/:id/reservations | url:POST|/api/v1/calendar_events/:id/reservations |
POST | /api/v1/calendar_events/:id/reservations/:participant_id | url:POST|/api/v1/calendar_events/:id/reservations/:participant_id |
GET | /api/v1/courses/:course_id/calendar_events/timetable | url:GET|/api/v1/courses/:course_id/calendar_events/timetable |
POST | /api/v1/courses/:course_id/calendar_events/timetable | url:POST|/api/v1/courses/:course_id/calendar_events/timetable |
POST | /api/v1/courses/:course_id/calendar_events/timetable_events | url:POST|/api/v1/courses/:course_id/calendar_events/timetable_events |
Collaborations
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/courses/:course_id/collaborations | url:GET|/api/v1/courses/:course_id/collaborations |
GET | /api/v1/collaborations/:id/members | url:GET|/api/v1/collaborations/:id/members |
GET | /api/v1/courses/:course_id/potential_collaborators | url:GET|/api/v1/courses/:course_id/potential_collaborators |
GET | /api/v1/groups/:group_id/potential_collaborators | url:GET|/api/v1/groups/:group_id/potential_collaborators |
GET | /api/v1/groups/:group_id/collaborations | url:GET|/api/v1/groups/:group_id/collaborations |
CommMessages
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/comm_messages | url:GET|/api/v1/comm_messages |
Communication Channels
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/users/:user_id/communication_channels | url:GET|/api/v1/users/:user_id/communication_channels |
POST | /api/v1/users/:user_id/communication_channels | url:POST|/api/v1/users/:user_id/communication_channels |
DELETE | /api/v1/users/self/communication_channels/push | url:DELETE|/api/v1/users/self/communication_channels/push |
DELETE | /api/v1/users/:user_id/communication_channels/:id | url:DELETE|/api/v1/users/:user_id/communication_channels/:id |
DELETE | /api/v1/users/:user_id/communication_channels/:type/:address | url:DELETE|/api/v1/users/:user_id/communication_channels/:type/:address |
Conferences
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/courses/:course_id/conferences | url:GET|/api/v1/courses/:course_id/conferences |
GET | /api/v1/groups/:group_id/conferences | url:GET|/api/v1/groups/:group_id/conferences |
Content Exports
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/courses/:course_id/content_exports | url:GET|/api/v1/courses/:course_id/content_exports |
POST | /api/v1/courses/:course_id/content_exports | url:POST|/api/v1/courses/:course_id/content_exports |
GET | /api/v1/courses/:course_id/content_exports/:id | url:GET|/api/v1/courses/:course_id/content_exports/:id |
GET | /api/v1/groups/:group_id/content_exports | url:GET|/api/v1/groups/:group_id/content_exports |
POST | /api/v1/groups/:group_id/content_exports | url:POST|/api/v1/groups/:group_id/content_exports |
GET | /api/v1/groups/:group_id/content_exports/:id | url:GET|/api/v1/groups/:group_id/content_exports/:id |
GET | /api/v1/users/:user_id/content_exports | url:GET|/api/v1/users/:user_id/content_exports |
POST | /api/v1/users/:user_id/content_exports | url:POST|/api/v1/users/:user_id/content_exports |
GET | /api/v1/users/:user_id/content_exports/:id | url:GET|/api/v1/users/:user_id/content_exports/:id |
Content Migrations
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/accounts/:account_id/content_migrations/migrators | url:GET|/api/v1/accounts/:account_id/content_migrations/migrators |
GET | /api/v1/accounts/:account_id/content_migrations/:id | url:GET|/api/v1/accounts/:account_id/content_migrations/:id |
GET | /api/v1/accounts/:account_id/content_migrations | url:GET|/api/v1/accounts/:account_id/content_migrations |
POST | /api/v1/accounts/:account_id/content_migrations | url:POST|/api/v1/accounts/:account_id/content_migrations |
PUT | /api/v1/accounts/:account_id/content_migrations/:id | url:PUT|/api/v1/accounts/:account_id/content_migrations/:id |
GET | /api/v1/courses/:course_id/content_migrations/migrators | url:GET|/api/v1/courses/:course_id/content_migrations/migrators |
GET | /api/v1/courses/:course_id/content_migrations/:id | url:GET|/api/v1/courses/:course_id/content_migrations/:id |
GET | /api/v1/courses/:course_id/content_migrations | url:GET|/api/v1/courses/:course_id/content_migrations |
POST | /api/v1/courses/:course_id/content_migrations | url:POST|/api/v1/courses/:course_id/content_migrations |
PUT | /api/v1/courses/:course_id/content_migrations/:id | url:PUT|/api/v1/courses/:course_id/content_migrations/:id |
GET | /api/v1/groups/:group_id/content_migrations/migrators | url:GET|/api/v1/groups/:group_id/content_migrations/migrators |
GET | /api/v1/groups/:group_id/content_migrations/:id | url:GET|/api/v1/groups/:group_id/content_migrations/:id |
GET | /api/v1/groups/:group_id/content_migrations | url:GET|/api/v1/groups/:group_id/content_migrations |
POST | /api/v1/groups/:group_id/content_migrations | url:POST|/api/v1/groups/:group_id/content_migrations |
PUT | /api/v1/groups/:group_id/content_migrations/:id | url:PUT|/api/v1/groups/:group_id/content_migrations/:id |
GET | /api/v1/users/:user_id/content_migrations/migrators | url:GET|/api/v1/users/:user_id/content_migrations/migrators |
GET | /api/v1/users/:user_id/content_migrations/:id | url:GET|/api/v1/users/:user_id/content_migrations/:id |
GET | /api/v1/users/:user_id/content_migrations | url:GET|/api/v1/users/:user_id/content_migrations |
POST | /api/v1/users/:user_id/content_migrations | url:POST|/api/v1/users/:user_id/content_migrations |
PUT | /api/v1/users/:user_id/content_migrations/:id | url:PUT|/api/v1/users/:user_id/content_migrations/:id |
GET | /api/v1/accounts/:account_id/content_migrations/:content_migration_id/migration_issues/:id | url:GET|/api/v1/accounts/:account_id/content_migrations/:content_migration_id/migration_issues/:id |
GET | /api/v1/accounts/:account_id/content_migrations/:content_migration_id/migration_issues | url:GET|/api/v1/accounts/:account_id/content_migrations/:content_migration_id/migration_issues |
PUT | /api/v1/accounts/:account_id/content_migrations/:content_migration_id/migration_issues/:id | url:PUT|/api/v1/accounts/:account_id/content_migrations/:content_migration_id/migration_issues/:id |
GET | /api/v1/courses/:course_id/content_migrations/:content_migration_id/migration_issues/:id | url:GET|/api/v1/courses/:course_id/content_migrations/:content_migration_id/migration_issues/:id |
GET | /api/v1/courses/:course_id/content_migrations/:content_migration_id/migration_issues | url:GET|/api/v1/courses/:course_id/content_migrations/:content_migration_id/migration_issues |
PUT | /api/v1/courses/:course_id/content_migrations/:content_migration_id/migration_issues/:id | url:PUT|/api/v1/courses/:course_id/content_migrations/:content_migration_id/migration_issues/:id |
GET | /api/v1/groups/:group_id/content_migrations/:content_migration_id/migration_issues/:id | url:GET|/api/v1/groups/:group_id/content_migrations/:content_migration_id/migration_issues/:id |
GET | /api/v1/groups/:group_id/content_migrations/:content_migration_id/migration_issues | url:GET|/api/v1/groups/:group_id/content_migrations/:content_migration_id/migration_issues |
PUT | /api/v1/groups/:group_id/content_migrations/:content_migration_id/migration_issues/:id | url:PUT|/api/v1/groups/:group_id/content_migrations/:content_migration_id/migration_issues/:id |
GET | /api/v1/users/:user_id/content_migrations/:content_migration_id/migration_issues/:id | url:GET|/api/v1/users/:user_id/content_migrations/:content_migration_id/migration_issues/:id |
GET | /api/v1/users/:user_id/content_migrations/:content_migration_id/migration_issues | url:GET|/api/v1/users/:user_id/content_migrations/:content_migration_id/migration_issues |
PUT | /api/v1/users/:user_id/content_migrations/:content_migration_id/migration_issues/:id | url:PUT|/api/v1/users/:user_id/content_migrations/:content_migration_id/migration_issues/:id |
Conversations
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/conversations | url:GET|/api/v1/conversations |
POST | /api/v1/conversations | url:POST|/api/v1/conversations |
POST | /api/v1/conversations/mark_all_as_read | url:POST|/api/v1/conversations/mark_all_as_read |
GET | /api/v1/conversations/batches | url:GET|/api/v1/conversations/batches |
GET | /api/v1/conversations/unread_count | url:GET|/api/v1/conversations/unread_count |
GET | /api/v1/conversations/:id | url:GET|/api/v1/conversations/:id |
PUT | /api/v1/conversations/:id | url:PUT|/api/v1/conversations/:id |
DELETE | /api/v1/conversations/:id | url:DELETE|/api/v1/conversations/:id |
POST | /api/v1/conversations/:id/add_message | url:POST|/api/v1/conversations/:id/add_message |
POST | /api/v1/conversations/:id/add_recipients | url:POST|/api/v1/conversations/:id/add_recipients |
POST | /api/v1/conversations/:id/remove_messages | url:POST|/api/v1/conversations/:id/remove_messages |
PUT | /api/v1/conversations | url:PUT|/api/v1/conversations |
Course Audit log
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/audit/course/courses/:course_id | url:GET|/api/v1/audit/course/courses/:course_id |
Courses
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/courses | url:GET|/api/v1/courses |
PUT | /api/v1/courses/:id | url:PUT|/api/v1/courses/:id |
GET | /api/v1/courses/:id | url:GET|/api/v1/courses/:id |
DELETE | /api/v1/courses/:id | url:DELETE|/api/v1/courses/:id |
POST | /api/v1/accounts/:account_id/courses | url:POST|/api/v1/accounts/:account_id/courses |
GET | /api/v1/courses/:course_id/students | url:GET|/api/v1/courses/:course_id/students |
GET | /api/v1/courses/:course_id/settings | url:GET|/api/v1/courses/:course_id/settings |
PUT | /api/v1/courses/:course_id/settings | url:PUT|/api/v1/courses/:course_id/settings |
GET | /api/v1/courses/:course_id/recent_students | url:GET|/api/v1/courses/:course_id/recent_students |
GET | /api/v1/courses/:course_id/users | url:GET|/api/v1/courses/:course_id/users |
GET | /api/v1/courses/:course_id/search_users | url:GET|/api/v1/courses/:course_id/search_users |
GET | /api/v1/courses/:course_id/users/:id | url:GET|/api/v1/courses/:course_id/users/:id |
GET | /api/v1/courses/:course_id/activity_stream | url:GET|/api/v1/courses/:course_id/activity_stream |
GET | /api/v1/courses/:course_id/activity_stream/summary | url:GET|/api/v1/courses/:course_id/activity_stream/summary |
GET | /api/v1/courses/:course_id/todo | url:GET|/api/v1/courses/:course_id/todo |
POST | /api/v1/courses/:course_id/preview_html | url:POST|/api/v1/courses/:course_id/preview_html |
POST | /api/v1/courses/:course_id/course_copy | url:POST|/api/v1/courses/:course_id/course_copy |
GET | /api/v1/courses/:course_id/course_copy/:id | url:GET|/api/v1/courses/:course_id/course_copy/:id |
POST | /api/v1/courses/:course_id/files | url:POST|/api/v1/courses/:course_id/files |
PUT | /api/v1/accounts/:account_id/courses | url:PUT|/api/v1/accounts/:account_id/courses |
POST | /api/v1/courses/:course_id/reset_content | url:POST|/api/v1/courses/:course_id/reset_content |
GET | /api/v1/users/:user_id/courses | url:GET|/api/v1/users/:user_id/courses |
GET | /api/v1/courses/:course_id/effective_due_dates | url:GET|/api/v1/courses/:course_id/effective_due_dates |
GET | /api/v1/courses/:course_id/permissions | url:GET|/api/v1/courses/:course_id/permissions |
GET | /api/v1/accounts/:account_id/courses/:id | url:GET|/api/v1/accounts/:account_id/courses/:id |
Custom Gradebook Columns
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/courses/:course_id/custom_gradebook_columns | url:GET|/api/v1/courses/:course_id/custom_gradebook_columns |
POST | /api/v1/courses/:course_id/custom_gradebook_columns | url:POST|/api/v1/courses/:course_id/custom_gradebook_columns |
POST | /api/v1/courses/:course_id/custom_gradebook_columns/reorder | url:POST|/api/v1/courses/:course_id/custom_gradebook_columns/reorder |
PUT | /api/v1/courses/:course_id/custom_gradebook_columns/:id | url:PUT|/api/v1/courses/:course_id/custom_gradebook_columns/:id |
DELETE | /api/v1/courses/:course_id/custom_gradebook_columns/:id | url:DELETE|/api/v1/courses/:course_id/custom_gradebook_columns/:id |
GET | /api/v1/courses/:course_id/custom_gradebook_columns/:id/data | url:GET|/api/v1/courses/:course_id/custom_gradebook_columns/:id/data |
PUT | /api/v1/courses/:course_id/custom_gradebook_columns/:id/data/:user_id | url:PUT|/api/v1/courses/:course_id/custom_gradebook_columns/:id/data/:user_id |
Discussion Topics
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/courses/:course_id/discussion_topics | url:GET|/api/v1/courses/:course_id/discussion_topics |
GET | /api/v1/groups/:group_id/discussion_topics | url:GET|/api/v1/groups/:group_id/discussion_topics |
GET | /api/v1/courses/:course_id/discussion_topics/:topic_id | url:GET|/api/v1/courses/:course_id/discussion_topics/:topic_id |
POST | /api/v1/courses/:course_id/discussion_topics | url:POST|/api/v1/courses/:course_id/discussion_topics |
PUT | /api/v1/courses/:course_id/discussion_topics/:topic_id | url:PUT|/api/v1/courses/:course_id/discussion_topics/:topic_id |
POST | /api/v1/courses/:course_id/discussion_topics/reorder | url:POST|/api/v1/courses/:course_id/discussion_topics/reorder |
DELETE | /api/v1/courses/:course_id/discussion_topics/:topic_id | url:DELETE|/api/v1/courses/:course_id/discussion_topics/:topic_id |
GET | /api/v1/courses/:course_id/discussion_topics/:topic_id/view | url:GET|/api/v1/courses/:course_id/discussion_topics/:topic_id/view |
GET | /api/v1/courses/:course_id/discussion_topics/:topic_id/entry_list | url:GET|/api/v1/courses/:course_id/discussion_topics/:topic_id/entry_list |
POST | /api/v1/courses/:course_id/discussion_topics/:topic_id/entries | url:POST|/api/v1/courses/:course_id/discussion_topics/:topic_id/entries |
GET | /api/v1/courses/:course_id/discussion_topics/:topic_id/entries | url:GET|/api/v1/courses/:course_id/discussion_topics/:topic_id/entries |
POST | /api/v1/courses/:course_id/discussion_topics/:topic_id/entries/:entry_id/replies | url:POST|/api/v1/courses/:course_id/discussion_topics/:topic_id/entries/:entry_id/replies |
GET | /api/v1/courses/:course_id/discussion_topics/:topic_id/entries/:entry_id/replies | url:GET|/api/v1/courses/:course_id/discussion_topics/:topic_id/entries/:entry_id/replies |
PUT | /api/v1/courses/:course_id/discussion_topics/:topic_id/entries/:id | url:PUT|/api/v1/courses/:course_id/discussion_topics/:topic_id/entries/:id |
DELETE | /api/v1/courses/:course_id/discussion_topics/:topic_id/entries/:id | url:DELETE|/api/v1/courses/:course_id/discussion_topics/:topic_id/entries/:id |
PUT | /api/v1/courses/:course_id/discussion_topics/:topic_id/read | url:PUT|/api/v1/courses/:course_id/discussion_topics/:topic_id/read |
DELETE | /api/v1/courses/:course_id/discussion_topics/:topic_id/read | url:DELETE|/api/v1/courses/:course_id/discussion_topics/:topic_id/read |
PUT | /api/v1/courses/:course_id/discussion_topics/:topic_id/read_all | url:PUT|/api/v1/courses/:course_id/discussion_topics/:topic_id/read_all |
DELETE | /api/v1/courses/:course_id/discussion_topics/:topic_id/read_all | url:DELETE|/api/v1/courses/:course_id/discussion_topics/:topic_id/read_all |
PUT | /api/v1/courses/:course_id/discussion_topics/:topic_id/entries/:entry_id/read | url:PUT|/api/v1/courses/:course_id/discussion_topics/:topic_id/entries/:entry_id/read |
DELETE | /api/v1/courses/:course_id/discussion_topics/:topic_id/entries/:entry_id/read | url:DELETE|/api/v1/courses/:course_id/discussion_topics/:topic_id/entries/:entry_id/read |
POST | /api/v1/courses/:course_id/discussion_topics/:topic_id/entries/:entry_id/rating | url:POST|/api/v1/courses/:course_id/discussion_topics/:topic_id/entries/:entry_id/rating |
PUT | /api/v1/courses/:course_id/discussion_topics/:topic_id/subscribed | url:PUT|/api/v1/courses/:course_id/discussion_topics/:topic_id/subscribed |
DELETE | /api/v1/courses/:course_id/discussion_topics/:topic_id/subscribed | url:DELETE|/api/v1/courses/:course_id/discussion_topics/:topic_id/subscribed |
GET | /api/v1/groups/:group_id/discussion_topics/:topic_id | url:GET|/api/v1/groups/:group_id/discussion_topics/:topic_id |
POST | /api/v1/groups/:group_id/discussion_topics | url:POST|/api/v1/groups/:group_id/discussion_topics |
PUT | /api/v1/groups/:group_id/discussion_topics/:topic_id | url:PUT|/api/v1/groups/:group_id/discussion_topics/:topic_id |
POST | /api/v1/groups/:group_id/discussion_topics/reorder | url:POST|/api/v1/groups/:group_id/discussion_topics/reorder |
DELETE | /api/v1/groups/:group_id/discussion_topics/:topic_id | url:DELETE|/api/v1/groups/:group_id/discussion_topics/:topic_id |
GET | /api/v1/groups/:group_id/discussion_topics/:topic_id/view | url:GET|/api/v1/groups/:group_id/discussion_topics/:topic_id/view |
GET | /api/v1/groups/:group_id/discussion_topics/:topic_id/entry_list | url:GET|/api/v1/groups/:group_id/discussion_topics/:topic_id/entry_list |
POST | /api/v1/groups/:group_id/discussion_topics/:topic_id/entries | url:POST|/api/v1/groups/:group_id/discussion_topics/:topic_id/entries |
GET | /api/v1/groups/:group_id/discussion_topics/:topic_id/entries | url:GET|/api/v1/groups/:group_id/discussion_topics/:topic_id/entries |
POST | /api/v1/groups/:group_id/discussion_topics/:topic_id/entries/:entry_id/replies | url:POST|/api/v1/groups/:group_id/discussion_topics/:topic_id/entries/:entry_id/replies |
GET | /api/v1/groups/:group_id/discussion_topics/:topic_id/entries/:entry_id/replies | url:GET|/api/v1/groups/:group_id/discussion_topics/:topic_id/entries/:entry_id/replies |
PUT | /api/v1/groups/:group_id/discussion_topics/:topic_id/entries/:id | url:PUT|/api/v1/groups/:group_id/discussion_topics/:topic_id/entries/:id |
DELETE | /api/v1/groups/:group_id/discussion_topics/:topic_id/entries/:id | url:DELETE|/api/v1/groups/:group_id/discussion_topics/:topic_id/entries/:id |
PUT | /api/v1/groups/:group_id/discussion_topics/:topic_id/read | url:PUT|/api/v1/groups/:group_id/discussion_topics/:topic_id/read |
DELETE | /api/v1/groups/:group_id/discussion_topics/:topic_id/read | url:DELETE|/api/v1/groups/:group_id/discussion_topics/:topic_id/read |
PUT | /api/v1/groups/:group_id/discussion_topics/:topic_id/read_all | url:PUT|/api/v1/groups/:group_id/discussion_topics/:topic_id/read_all |
DELETE | /api/v1/groups/:group_id/discussion_topics/:topic_id/read_all | url:DELETE|/api/v1/groups/:group_id/discussion_topics/:topic_id/read_all |
PUT | /api/v1/groups/:group_id/discussion_topics/:topic_id/entries/:entry_id/read | url:PUT|/api/v1/groups/:group_id/discussion_topics/:topic_id/entries/:entry_id/read |
DELETE | /api/v1/groups/:group_id/discussion_topics/:topic_id/entries/:entry_id/read | url:DELETE|/api/v1/groups/:group_id/discussion_topics/:topic_id/entries/:entry_id/read |
POST | /api/v1/groups/:group_id/discussion_topics/:topic_id/entries/:entry_id/rating | url:POST|/api/v1/groups/:group_id/discussion_topics/:topic_id/entries/:entry_id/rating |
PUT | /api/v1/groups/:group_id/discussion_topics/:topic_id/subscribed | url:PUT|/api/v1/groups/:group_id/discussion_topics/:topic_id/subscribed |
DELETE | /api/v1/groups/:group_id/discussion_topics/:topic_id/subscribed | url:DELETE|/api/v1/groups/:group_id/discussion_topics/:topic_id/subscribed |
Enrollment Terms
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/accounts/:account_id/terms | url:GET|/api/v1/accounts/:account_id/terms |
POST | /api/v1/accounts/:account_id/terms | url:POST|/api/v1/accounts/:account_id/terms |
PUT | /api/v1/accounts/:account_id/terms/:id | url:PUT|/api/v1/accounts/:account_id/terms/:id |
DELETE | /api/v1/accounts/:account_id/terms/:id | url:DELETE|/api/v1/accounts/:account_id/terms/:id |
Enrollments
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/courses/:course_id/enrollments | url:GET|/api/v1/courses/:course_id/enrollments |
GET | /api/v1/sections/:section_id/enrollments | url:GET|/api/v1/sections/:section_id/enrollments |
GET | /api/v1/users/:user_id/enrollments | url:GET|/api/v1/users/:user_id/enrollments |
GET | /api/v1/accounts/:account_id/enrollments/:id | url:GET|/api/v1/accounts/:account_id/enrollments/:id |
POST | /api/v1/courses/:course_id/enrollments | url:POST|/api/v1/courses/:course_id/enrollments |
POST | /api/v1/sections/:section_id/enrollments | url:POST|/api/v1/sections/:section_id/enrollments |
POST | /api/v1/courses/:course_id/enrollments/:id/accept | url:POST|/api/v1/courses/:course_id/enrollments/:id/accept |
POST | /api/v1/courses/:course_id/enrollments/:id/reject | url:POST|/api/v1/courses/:course_id/enrollments/:id/reject |
PUT | /api/v1/courses/:course_id/users/:user_id/last_attended | url:PUT|/api/v1/courses/:course_id/users/:user_id/last_attended |
PUT | /api/v1/courses/:course_id/enrollments/:id/reactivate | url:PUT|/api/v1/courses/:course_id/enrollments/:id/reactivate |
DELETE | /api/v1/courses/:course_id/enrollments/:id | url:DELETE|/api/v1/courses/:course_id/enrollments/:id |
ePub Exports
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/courses/:course_id/epub_exports/:id | url:GET|/api/v1/courses/:course_id/epub_exports/:id |
GET | /api/v1/epub_exports | url:GET|/api/v1/epub_exports |
POST | /api/v1/courses/:course_id/epub_exports | url:POST|/api/v1/courses/:course_id/epub_exports |
Error Reports
Verb | Endpoint | Scope |
---|---|---|
POST | /api/v1/error_reports | url:POST|/api/v1/error_reports |
External Tools
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/courses/:course_id/external_tools/sessionless_launch | url:GET|/api/v1/courses/:course_id/external_tools/sessionless_launch |
GET | /api/v1/courses/:course_id/external_tools/:external_tool_id | url:GET|/api/v1/courses/:course_id/external_tools/:external_tool_id |
GET | /api/v1/courses/:course_id/external_tools | url:GET|/api/v1/courses/:course_id/external_tools |
POST | /api/v1/courses/:course_id/external_tools | url:POST|/api/v1/courses/:course_id/external_tools |
PUT | /api/v1/courses/:course_id/external_tools/:external_tool_id | url:PUT|/api/v1/courses/:course_id/external_tools/:external_tool_id |
DELETE | /api/v1/courses/:course_id/external_tools/:external_tool_id | url:DELETE|/api/v1/courses/:course_id/external_tools/:external_tool_id |
GET | /api/v1/accounts/:account_id/external_tools/sessionless_launch | url:GET|/api/v1/accounts/:account_id/external_tools/sessionless_launch |
GET | /api/v1/accounts/:account_id/external_tools/:external_tool_id | url:GET|/api/v1/accounts/:account_id/external_tools/:external_tool_id |
GET | /api/v1/accounts/:account_id/external_tools | url:GET|/api/v1/accounts/:account_id/external_tools |
POST | /api/v1/accounts/:account_id/external_tools | url:POST|/api/v1/accounts/:account_id/external_tools |
PUT | /api/v1/accounts/:account_id/external_tools/:external_tool_id | url:PUT|/api/v1/accounts/:account_id/external_tools/:external_tool_id |
DELETE | /api/v1/accounts/:account_id/external_tools/:external_tool_id | url:DELETE|/api/v1/accounts/:account_id/external_tools/:external_tool_id |
GET | /api/v1/groups/:group_id/external_tools | url:GET|/api/v1/groups/:group_id/external_tools |
Favorites
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/users/self/favorites/courses | url:GET|/api/v1/users/self/favorites/courses |
POST | /api/v1/users/self/favorites/courses/:id | url:POST|/api/v1/users/self/favorites/courses/:id |
DELETE | /api/v1/users/self/favorites/courses/:id | url:DELETE|/api/v1/users/self/favorites/courses/:id |
DELETE | /api/v1/users/self/favorites/courses | url:DELETE|/api/v1/users/self/favorites/courses |
GET | /api/v1/users/self/favorites/groups | url:GET|/api/v1/users/self/favorites/groups |
POST | /api/v1/users/self/favorites/groups/:id | url:POST|/api/v1/users/self/favorites/groups/:id |
DELETE | /api/v1/users/self/favorites/groups/:id | url:DELETE|/api/v1/users/self/favorites/groups/:id |
DELETE | /api/v1/users/self/favorites/groups | url:DELETE|/api/v1/users/self/favorites/groups |
Feature Flags
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/courses/:course_id/features | url:GET|/api/v1/courses/:course_id/features |
GET | /api/v1/courses/:course_id/features/enabled | url:GET|/api/v1/courses/:course_id/features/enabled |
GET | /api/v1/courses/:course_id/features/flags/:feature | url:GET|/api/v1/courses/:course_id/features/flags/:feature |
PUT | /api/v1/courses/:course_id/features/flags/:feature | url:PUT|/api/v1/courses/:course_id/features/flags/:feature |
DELETE | /api/v1/courses/:course_id/features/flags/:feature | url:DELETE|/api/v1/courses/:course_id/features/flags/:feature |
GET | /api/v1/accounts/:account_id/features | url:GET|/api/v1/accounts/:account_id/features |
GET | /api/v1/accounts/:account_id/features/enabled | url:GET|/api/v1/accounts/:account_id/features/enabled |
GET | /api/v1/accounts/:account_id/features/flags/:feature | url:GET|/api/v1/accounts/:account_id/features/flags/:feature |
PUT | /api/v1/accounts/:account_id/features/flags/:feature | url:PUT|/api/v1/accounts/:account_id/features/flags/:feature |
DELETE | /api/v1/accounts/:account_id/features/flags/:feature | url:DELETE|/api/v1/accounts/:account_id/features/flags/:feature |
GET | /api/v1/users/:user_id/features | url:GET|/api/v1/users/:user_id/features |
GET | /api/v1/users/:user_id/features/enabled | url:GET|/api/v1/users/:user_id/features/enabled |
GET | /api/v1/users/:user_id/features/flags/:feature | url:GET|/api/v1/users/:user_id/features/flags/:feature |
PUT | /api/v1/users/:user_id/features/flags/:feature | url:PUT|/api/v1/users/:user_id/features/flags/:feature |
DELETE | /api/v1/users/:user_id/features/flags/:feature | url:DELETE|/api/v1/users/:user_id/features/flags/:feature |
Files
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/courses/:course_id/files | url:GET|/api/v1/courses/:course_id/files |
GET | /api/v1/courses/:course_id/folders | url:GET|/api/v1/courses/:course_id/folders |
POST | /api/v1/courses/:course_id/folders | url:POST|/api/v1/courses/:course_id/folders |
GET | /api/v1/courses/:course_id/folders/by_path/*full_path | url:GET|/api/v1/courses/:course_id/folders/by_path/*full_path |
GET | /api/v1/courses/:course_id/folders/by_path | url:GET|/api/v1/courses/:course_id/folders/by_path |
GET | /api/v1/courses/:course_id/folders/:id | url:GET|/api/v1/courses/:course_id/folders/:id |
GET | /api/v1/users/:user_id/files | url:GET|/api/v1/users/:user_id/files |
GET | /api/v1/users/:user_id/folders | url:GET|/api/v1/users/:user_id/folders |
POST | /api/v1/users/:user_id/folders | url:POST|/api/v1/users/:user_id/folders |
GET | /api/v1/users/:user_id/folders/by_path/*full_path | url:GET|/api/v1/users/:user_id/folders/by_path/*full_path |
GET | /api/v1/users/:user_id/folders/by_path | url:GET|/api/v1/users/:user_id/folders/by_path |
GET | /api/v1/users/:user_id/folders/:id | url:GET|/api/v1/users/:user_id/folders/:id |
GET | /api/v1/groups/:group_id/files | url:GET|/api/v1/groups/:group_id/files |
GET | /api/v1/groups/:group_id/folders | url:GET|/api/v1/groups/:group_id/folders |
POST | /api/v1/groups/:group_id/folders | url:POST|/api/v1/groups/:group_id/folders |
GET | /api/v1/groups/:group_id/folders/by_path/*full_path | url:GET|/api/v1/groups/:group_id/folders/by_path/*full_path |
GET | /api/v1/groups/:group_id/folders/by_path | url:GET|/api/v1/groups/:group_id/folders/by_path |
GET | /api/v1/groups/:group_id/folders/:id | url:GET|/api/v1/groups/:group_id/folders/:id |
GET | /api/v1/files/:id | url:GET|/api/v1/files/:id |
DELETE | /api/v1/files/:id | url:DELETE|/api/v1/files/:id |
PUT | /api/v1/files/:id | url:PUT|/api/v1/files/:id |
GET | /api/v1/files/:id/public_url | url:GET|/api/v1/files/:id/public_url |
GET | /api/v1/courses/:course_id/files/quota | url:GET|/api/v1/courses/:course_id/files/quota |
GET | /api/v1/courses/:course_id/files/:id | url:GET|/api/v1/courses/:course_id/files/:id |
GET | /api/v1/groups/:group_id/files/quota | url:GET|/api/v1/groups/:group_id/files/quota |
GET | /api/v1/groups/:group_id/files/:id | url:GET|/api/v1/groups/:group_id/files/:id |
GET | /api/v1/users/:user_id/files/quota | url:GET|/api/v1/users/:user_id/files/quota |
GET | /api/v1/users/:user_id/files/:id | url:GET|/api/v1/users/:user_id/files/:id |
GET | /api/v1/folders/:id | url:GET|/api/v1/folders/:id |
GET | /api/v1/folders/:id/folders | url:GET|/api/v1/folders/:id/folders |
GET | /api/v1/folders/:id/files | url:GET|/api/v1/folders/:id/files |
DELETE | /api/v1/folders/:id | url:DELETE|/api/v1/folders/:id |
PUT | /api/v1/folders/:id | url:PUT|/api/v1/folders/:id |
POST | /api/v1/folders/:folder_id/folders | url:POST|/api/v1/folders/:folder_id/folders |
POST | /api/v1/folders/:folder_id/files | url:POST|/api/v1/folders/:folder_id/files |
POST | /api/v1/folders/:dest_folder_id/copy_file | url:POST|/api/v1/folders/:dest_folder_id/copy_file |
POST | /api/v1/folders/:dest_folder_id/copy_folder | url:POST|/api/v1/folders/:dest_folder_id/copy_folder |
PUT | /api/v1/courses/:course_id/usage_rights | url:PUT|/api/v1/courses/:course_id/usage_rights |
DELETE | /api/v1/courses/:course_id/usage_rights | url:DELETE|/api/v1/courses/:course_id/usage_rights |
GET | /api/v1/courses/:course_id/content_licenses | url:GET|/api/v1/courses/:course_id/content_licenses |
PUT | /api/v1/groups/:group_id/usage_rights | url:PUT|/api/v1/groups/:group_id/usage_rights |
DELETE | /api/v1/groups/:group_id/usage_rights | url:DELETE|/api/v1/groups/:group_id/usage_rights |
GET | /api/v1/groups/:group_id/content_licenses | url:GET|/api/v1/groups/:group_id/content_licenses |
PUT | /api/v1/users/:user_id/usage_rights | url:PUT|/api/v1/users/:user_id/usage_rights |
DELETE | /api/v1/users/:user_id/usage_rights | url:DELETE|/api/v1/users/:user_id/usage_rights |
GET | /api/v1/users/:user_id/content_licenses | url:GET|/api/v1/users/:user_id/content_licenses |
Grade Change Log
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/audit/grade_change/assignments/:assignment_id | url:GET|/api/v1/audit/grade_change/assignments/:assignment_id |
GET | /api/v1/audit/grade_change/courses/:course_id | url:GET|/api/v1/audit/grade_change/courses/:course_id |
GET | /api/v1/audit/grade_change/students/:student_id | url:GET|/api/v1/audit/grade_change/students/:student_id |
GET | /api/v1/audit/grade_change/graders/:grader_id | url:GET|/api/v1/audit/grade_change/graders/:grader_id |
Gradebook History
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/courses/:course_id/gradebook_history/days | url:GET|/api/v1/courses/:course_id/gradebook_history/days |
GET | /api/v1/courses/:course_id/gradebook_history/feed | url:GET|/api/v1/courses/:course_id/gradebook_history/feed |
GET | /api/v1/courses/:course_id/gradebook_history/:date | url:GET|/api/v1/courses/:course_id/gradebook_history/:date |
GET | /api/v1/courses/:course_id/gradebook_history/:date/graders/:grader_id/assignments/:assignment_id/submissions | url:GET|/api/v1/courses/:course_id/gradebook_history/:date/graders/:grader_id/assignments/:assignment_id/submissions |
Grading Periods
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/accounts/:account_id/grading_periods | url:GET|/api/v1/accounts/:account_id/grading_periods |
GET | /api/v1/courses/:course_id/grading_periods | url:GET|/api/v1/courses/:course_id/grading_periods |
GET | /api/v1/courses/:course_id/grading_periods/:id | url:GET|/api/v1/courses/:course_id/grading_periods/:id |
PUT | /api/v1/courses/:course_id/grading_periods/:id | url:PUT|/api/v1/courses/:course_id/grading_periods/:id |
DELETE | /api/v1/courses/:course_id/grading_periods/:id | url:DELETE|/api/v1/courses/:course_id/grading_periods/:id |
DELETE | /api/v1/accounts/:account_id/grading_periods/:id | url:DELETE|/api/v1/accounts/:account_id/grading_periods/:id |
Grading Standards
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/courses/:course_id/grading_standards | url:GET|/api/v1/courses/:course_id/grading_standards |
GET | /api/v1/accounts/:account_id/grading_standards | url:GET|/api/v1/accounts/:account_id/grading_standards |
GET | /api/v1/courses/:course_id/grading_standards/:grading_standard_id | url:GET|/api/v1/courses/:course_id/grading_standards/:grading_standard_id |
GET | /api/v1/accounts/:account_id/grading_standards/:grading_standard_id | url:GET|/api/v1/accounts/:account_id/grading_standards/:grading_standard_id |
POST | /api/v1/accounts/:account_id/grading_standards | url:POST|/api/v1/accounts/:account_id/grading_standards |
POST | /api/v1/courses/:course_id/grading_standards | url:POST|/api/v1/courses/:course_id/grading_standards |
Group Categories
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/group_categories/:group_category_id | url:GET|/api/v1/group_categories/:group_category_id |
PUT | /api/v1/group_categories/:group_category_id | url:PUT|/api/v1/group_categories/:group_category_id |
DELETE | /api/v1/group_categories/:group_category_id | url:DELETE|/api/v1/group_categories/:group_category_id |
GET | /api/v1/accounts/:account_id/group_categories | url:GET|/api/v1/accounts/:account_id/group_categories |
GET | /api/v1/courses/:course_id/group_categories | url:GET|/api/v1/courses/:course_id/group_categories |
POST | /api/v1/accounts/:account_id/group_categories | url:POST|/api/v1/accounts/:account_id/group_categories |
POST | /api/v1/courses/:course_id/group_categories | url:POST|/api/v1/courses/:course_id/group_categories |
GET | /api/v1/group_categories/:group_category_id/groups | url:GET|/api/v1/group_categories/:group_category_id/groups |
GET | /api/v1/group_categories/:group_category_id/users | url:GET|/api/v1/group_categories/:group_category_id/users |
POST | /api/v1/group_categories/:group_category_id/assign_unassigned_members | url:POST|/api/v1/group_categories/:group_category_id/assign_unassigned_members |
Groups
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/groups/:group_id | url:GET|/api/v1/groups/:group_id |
POST | /api/v1/groups | url:POST|/api/v1/groups |
PUT | /api/v1/groups/:group_id | url:PUT|/api/v1/groups/:group_id |
DELETE | /api/v1/groups/:group_id | url:DELETE|/api/v1/groups/:group_id |
GET | /api/v1/users/self/groups | url:GET|/api/v1/users/self/groups |
GET | /api/v1/accounts/:account_id/groups | url:GET|/api/v1/accounts/:account_id/groups |
GET | /api/v1/courses/:course_id/groups | url:GET|/api/v1/courses/:course_id/groups |
GET | /api/v1/groups/:group_id/users | url:GET|/api/v1/groups/:group_id/users |
POST | /api/v1/groups/:group_id/invite | url:POST|/api/v1/groups/:group_id/invite |
POST | /api/v1/groups/:group_id/files | url:POST|/api/v1/groups/:group_id/files |
POST | /api/v1/groups/:group_id/preview_html | url:POST|/api/v1/groups/:group_id/preview_html |
POST | /api/v1/group_categories/:group_category_id/groups | url:POST|/api/v1/group_categories/:group_category_id/groups |
GET | /api/v1/groups/:group_id/activity_stream | url:GET|/api/v1/groups/:group_id/activity_stream |
GET | /api/v1/groups/:group_id/activity_stream/summary | url:GET|/api/v1/groups/:group_id/activity_stream/summary |
GET | /api/v1/groups/:group_id/memberships | url:GET|/api/v1/groups/:group_id/memberships |
GET | /api/v1/groups/:group_id/memberships/:membership_id | url:GET|/api/v1/groups/:group_id/memberships/:membership_id |
POST | /api/v1/groups/:group_id/memberships | url:POST|/api/v1/groups/:group_id/memberships |
PUT | /api/v1/groups/:group_id/memberships/:membership_id | url:PUT|/api/v1/groups/:group_id/memberships/:membership_id |
DELETE | /api/v1/groups/:group_id/memberships/:membership_id | url:DELETE|/api/v1/groups/:group_id/memberships/:membership_id |
GET | /api/v1/groups/:group_id/users/:user_id | url:GET|/api/v1/groups/:group_id/users/:user_id |
PUT | /api/v1/groups/:group_id/users/:user_id | url:PUT|/api/v1/groups/:group_id/users/:user_id |
DELETE | /api/v1/groups/:group_id/users/:user_id | url:DELETE|/api/v1/groups/:group_id/users/:user_id |
JWTs
Verb | Endpoint | Scope |
---|---|---|
POST | /api/v1/jwts | url:POST|/api/v1/jwts |
POST | /api/v1/jwts/refresh | url:POST|/api/v1/jwts/refresh |
Late Policy
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/courses/:id/late_policy | url:GET|/api/v1/courses/:id/late_policy |
POST | /api/v1/courses/:id/late_policy | url:POST|/api/v1/courses/:id/late_policy |
PATCH | /api/v1/courses/:id/late_policy | url:PATCH|/api/v1/courses/:id/late_policy |
Logins
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/accounts/:account_id/logins | url:GET|/api/v1/accounts/:account_id/logins |
GET | /api/v1/users/:user_id/logins | url:GET|/api/v1/users/:user_id/logins |
POST | /api/v1/accounts/:account_id/logins | url:POST|/api/v1/accounts/:account_id/logins |
PUT | /api/v1/accounts/:account_id/logins/:id | url:PUT|/api/v1/accounts/:account_id/logins/:id |
DELETE | /api/v1/users/:user_id/logins/:id | url:DELETE|/api/v1/users/:user_id/logins/:id |
Moderated Grading
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/courses/:course_id/assignments/:assignment_id/moderated_students | url:GET|/api/v1/courses/:course_id/assignments/:assignment_id/moderated_students |
POST | /api/v1/courses/:course_id/assignments/:assignment_id/moderated_students | url:POST|/api/v1/courses/:course_id/assignments/:assignment_id/moderated_students |
GET | /api/v1/courses/:course_id/assignments/:assignment_id/anonymous_provisional_grades/status | url:GET|/api/v1/courses/:course_id/assignments/:assignment_id/anonymous_provisional_grades/status |
GET | /api/v1/courses/:course_id/assignments/:assignment_id/provisional_grades/status | url:GET|/api/v1/courses/:course_id/assignments/:assignment_id/provisional_grades/status |
POST | /api/v1/courses/:course_id/assignments/:assignment_id/provisional_grades/publish | url:POST|/api/v1/courses/:course_id/assignments/:assignment_id/provisional_grades/publish |
PUT | /api/v1/courses/:course_id/assignments/:assignment_id/provisional_grades/:provisional_grade_id/select | url:PUT|/api/v1/courses/:course_id/assignments/:assignment_id/provisional_grades/:provisional_grade_id/select |
POST | /api/v1/courses/:course_id/assignments/:assignment_id/provisional_grades/:provisional_grade_id/copy_to_final_mark | url:POST|/api/v1/courses/:course_id/assignments/:assignment_id/provisional_grades/:provisional_grade_id/copy_to_final_mark |
Modules
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/courses/:course_id/modules | url:GET|/api/v1/courses/:course_id/modules |
GET | /api/v1/courses/:course_id/modules/:id | url:GET|/api/v1/courses/:course_id/modules/:id |
POST | /api/v1/courses/:course_id/modules | url:POST|/api/v1/courses/:course_id/modules |
PUT | /api/v1/courses/:course_id/modules/:id | url:PUT|/api/v1/courses/:course_id/modules/:id |
DELETE | /api/v1/courses/:course_id/modules/:id | url:DELETE|/api/v1/courses/:course_id/modules/:id |
PUT | /api/v1/courses/:course_id/modules/:id/relock | url:PUT|/api/v1/courses/:course_id/modules/:id/relock |
GET | /api/v1/courses/:course_id/modules/:module_id/items | url:GET|/api/v1/courses/:course_id/modules/:module_id/items |
GET | /api/v1/courses/:course_id/modules/:module_id/items/:id | url:GET|/api/v1/courses/:course_id/modules/:module_id/items/:id |
PUT | /api/v1/courses/:course_id/modules/:module_id/items/:id/done | url:PUT|/api/v1/courses/:course_id/modules/:module_id/items/:id/done |
GET | /api/v1/courses/:course_id/module_item_sequence | url:GET|/api/v1/courses/:course_id/module_item_sequence |
POST | /api/v1/courses/:course_id/modules/:module_id/items | url:POST|/api/v1/courses/:course_id/modules/:module_id/items |
PUT | /api/v1/courses/:course_id/modules/:module_id/items/:id | url:PUT|/api/v1/courses/:course_id/modules/:module_id/items/:id |
DELETE | /api/v1/courses/:course_id/modules/:module_id/items/:id | url:DELETE|/api/v1/courses/:course_id/modules/:module_id/items/:id |
POST | /api/v1/courses/:course_id/modules/:module_id/items/:id/mark_read | url:POST|/api/v1/courses/:course_id/modules/:module_id/items/:id/mark_read |
POST | /api/v1/courses/:course_id/modules/:module_id/items/:id/select_mastery_path | url:POST|/api/v1/courses/:course_id/modules/:module_id/items/:id/select_mastery_path |
Notification Preferences
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/users/:user_id/communication_channels/:communication_channel_id/notification_preferences | url:GET|/api/v1/users/:user_id/communication_channels/:communication_channel_id/notification_preferences |
GET | /api/v1/users/:user_id/communication_channels/:communication_channel_id/notification_preference_categories | url:GET|/api/v1/users/:user_id/communication_channels/:communication_channel_id/notification_preference_categories |
GET | /api/v1/users/:user_id/communication_channels/:type/:address/notification_preferences | url:GET|/api/v1/users/:user_id/communication_channels/:type/:address/notification_preferences |
GET | /api/v1/users/:user_id/communication_channels/:communication_channel_id/notification_preferences/:notification | url:GET|/api/v1/users/:user_id/communication_channels/:communication_channel_id/notification_preferences/:notification |
GET | /api/v1/users/:user_id/communication_channels/:type/:address/notification_preferences/:notification | url:GET|/api/v1/users/:user_id/communication_channels/:type/:address/notification_preferences/:notification |
PUT | /api/v1/users/self/communication_channels/:communication_channel_id/notification_preferences/:notification | url:PUT|/api/v1/users/self/communication_channels/:communication_channel_id/notification_preferences/:notification |
PUT | /api/v1/users/self/communication_channels/:type/:address/notification_preferences/:notification | url:PUT|/api/v1/users/self/communication_channels/:type/:address/notification_preferences/:notification |
PUT | /api/v1/users/self/communication_channels/:communication_channel_id/notification_preferences | url:PUT|/api/v1/users/self/communication_channels/:communication_channel_id/notification_preferences |
PUT | /api/v1/users/self/communication_channels/:type/:address/notification_preferences | url:PUT|/api/v1/users/self/communication_channels/:type/:address/notification_preferences |
PUT | /api/v1/users/self/communication_channels/:communication_channel_id/notification_preference_categories/:category | url:PUT|/api/v1/users/self/communication_channels/:communication_channel_id/notification_preference_categories/:category |
OAuth 2
Verb | Endpoint | Scope |
---|---|---|
GET | /auth/userinfo |
Outcome Groups
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/global/root_outcome_group | url:GET|/api/v1/global/root_outcome_group |
GET | /api/v1/global/outcome_groups/:id | url:GET|/api/v1/global/outcome_groups/:id |
PUT | /api/v1/global/outcome_groups/:id | url:PUT|/api/v1/global/outcome_groups/:id |
DELETE | /api/v1/global/outcome_groups/:id | url:DELETE|/api/v1/global/outcome_groups/:id |
GET | /api/v1/global/outcome_groups/:id/outcomes | url:GET|/api/v1/global/outcome_groups/:id/outcomes |
POST | /api/v1/global/outcome_groups/:id/outcomes | url:POST|/api/v1/global/outcome_groups/:id/outcomes |
PUT | /api/v1/global/outcome_groups/:id/outcomes/:outcome_id | url:PUT|/api/v1/global/outcome_groups/:id/outcomes/:outcome_id |
DELETE | /api/v1/global/outcome_groups/:id/outcomes/:outcome_id | url:DELETE|/api/v1/global/outcome_groups/:id/outcomes/:outcome_id |
GET | /api/v1/global/outcome_groups/:id/subgroups | url:GET|/api/v1/global/outcome_groups/:id/subgroups |
POST | /api/v1/global/outcome_groups/:id/subgroups | url:POST|/api/v1/global/outcome_groups/:id/subgroups |
POST | /api/v1/global/outcome_groups/:id/import | url:POST|/api/v1/global/outcome_groups/:id/import |
GET | /api/v1/accounts/:account_id/outcome_groups | url:GET|/api/v1/accounts/:account_id/outcome_groups |
GET | /api/v1/accounts/:account_id/outcome_group_links | url:GET|/api/v1/accounts/:account_id/outcome_group_links |
GET | /api/v1/accounts/:account_id/root_outcome_group | url:GET|/api/v1/accounts/:account_id/root_outcome_group |
GET | /api/v1/accounts/:account_id/outcome_groups/:id | url:GET|/api/v1/accounts/:account_id/outcome_groups/:id |
PUT | /api/v1/accounts/:account_id/outcome_groups/:id | url:PUT|/api/v1/accounts/:account_id/outcome_groups/:id |
DELETE | /api/v1/accounts/:account_id/outcome_groups/:id | url:DELETE|/api/v1/accounts/:account_id/outcome_groups/:id |
GET | /api/v1/accounts/:account_id/outcome_groups/:id/outcomes | url:GET|/api/v1/accounts/:account_id/outcome_groups/:id/outcomes |
POST | /api/v1/accounts/:account_id/outcome_groups/:id/outcomes | url:POST|/api/v1/accounts/:account_id/outcome_groups/:id/outcomes |
PUT | /api/v1/accounts/:account_id/outcome_groups/:id/outcomes/:outcome_id | url:PUT|/api/v1/accounts/:account_id/outcome_groups/:id/outcomes/:outcome_id |
DELETE | /api/v1/accounts/:account_id/outcome_groups/:id/outcomes/:outcome_id | url:DELETE|/api/v1/accounts/:account_id/outcome_groups/:id/outcomes/:outcome_id |
GET | /api/v1/accounts/:account_id/outcome_groups/:id/subgroups | url:GET|/api/v1/accounts/:account_id/outcome_groups/:id/subgroups |
POST | /api/v1/accounts/:account_id/outcome_groups/:id/subgroups | url:POST|/api/v1/accounts/:account_id/outcome_groups/:id/subgroups |
POST | /api/v1/accounts/:account_id/outcome_groups/:id/import | url:POST|/api/v1/accounts/:account_id/outcome_groups/:id/import |
GET | /api/v1/courses/:course_id/outcome_groups | url:GET|/api/v1/courses/:course_id/outcome_groups |
GET | /api/v1/courses/:course_id/outcome_group_links | url:GET|/api/v1/courses/:course_id/outcome_group_links |
GET | /api/v1/courses/:course_id/root_outcome_group | url:GET|/api/v1/courses/:course_id/root_outcome_group |
GET | /api/v1/courses/:course_id/outcome_groups/:id | url:GET|/api/v1/courses/:course_id/outcome_groups/:id |
PUT | /api/v1/courses/:course_id/outcome_groups/:id | url:PUT|/api/v1/courses/:course_id/outcome_groups/:id |
DELETE | /api/v1/courses/:course_id/outcome_groups/:id | url:DELETE|/api/v1/courses/:course_id/outcome_groups/:id |
GET | /api/v1/courses/:course_id/outcome_groups/:id/outcomes | url:GET|/api/v1/courses/:course_id/outcome_groups/:id/outcomes |
POST | /api/v1/courses/:course_id/outcome_groups/:id/outcomes | url:POST|/api/v1/courses/:course_id/outcome_groups/:id/outcomes |
PUT | /api/v1/courses/:course_id/outcome_groups/:id/outcomes/:outcome_id | url:PUT|/api/v1/courses/:course_id/outcome_groups/:id/outcomes/:outcome_id |
DELETE | /api/v1/courses/:course_id/outcome_groups/:id/outcomes/:outcome_id | url:DELETE|/api/v1/courses/:course_id/outcome_groups/:id/outcomes/:outcome_id |
GET | /api/v1/courses/:course_id/outcome_groups/:id/subgroups | url:GET|/api/v1/courses/:course_id/outcome_groups/:id/subgroups |
POST | /api/v1/courses/:course_id/outcome_groups/:id/subgroups | url:POST|/api/v1/courses/:course_id/outcome_groups/:id/subgroups |
POST | /api/v1/courses/:course_id/outcome_groups/:id/import | url:POST|/api/v1/courses/:course_id/outcome_groups/:id/import |
Outcome Imports
Verb | Endpoint | Scope |
---|---|---|
POST | /api/v1/accounts/:account_id/outcome_imports | url:POST|/api/v1/accounts/:account_id/outcome_imports |
GET | /api/v1/accounts/:account_id/outcome_imports/:id | url:GET|/api/v1/accounts/:account_id/outcome_imports/:id |
POST | /api/v1/courses/:course_id/outcome_imports | url:POST|/api/v1/courses/:course_id/outcome_imports |
GET | /api/v1/courses/:course_id/outcome_imports/:id | url:GET|/api/v1/courses/:course_id/outcome_imports/:id |
Outcome Results
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/courses/:course_id/outcome_rollups | url:GET|/api/v1/courses/:course_id/outcome_rollups |
GET | /api/v1/courses/:course_id/outcome_results | url:GET|/api/v1/courses/:course_id/outcome_results |
Outcomes
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/outcomes/:id | url:GET|/api/v1/outcomes/:id |
PUT | /api/v1/outcomes/:id | url:PUT|/api/v1/outcomes/:id |
Pages
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/courses/:course_id/front_page | url:GET|/api/v1/courses/:course_id/front_page |
GET | /api/v1/groups/:group_id/front_page | url:GET|/api/v1/groups/:group_id/front_page |
PUT | /api/v1/courses/:course_id/front_page | url:PUT|/api/v1/courses/:course_id/front_page |
PUT | /api/v1/groups/:group_id/front_page | url:PUT|/api/v1/groups/:group_id/front_page |
POST | /api/v1/courses/:course_id/pages/:url/duplicate | url:POST|/api/v1/courses/:course_id/pages/:url/duplicate |
GET | /api/v1/courses/:course_id/pages | url:GET|/api/v1/courses/:course_id/pages |
GET | /api/v1/groups/:group_id/pages | url:GET|/api/v1/groups/:group_id/pages |
GET | /api/v1/courses/:course_id/pages/:url | url:GET|/api/v1/courses/:course_id/pages/:url |
GET | /api/v1/groups/:group_id/pages/:url | url:GET|/api/v1/groups/:group_id/pages/:url |
GET | /api/v1/courses/:course_id/pages/:url/revisions | url:GET|/api/v1/courses/:course_id/pages/:url/revisions |
GET | /api/v1/groups/:group_id/pages/:url/revisions | url:GET|/api/v1/groups/:group_id/pages/:url/revisions |
GET | /api/v1/courses/:course_id/pages/:url/revisions/latest | url:GET|/api/v1/courses/:course_id/pages/:url/revisions/latest |
GET | /api/v1/groups/:group_id/pages/:url/revisions/latest | url:GET|/api/v1/groups/:group_id/pages/:url/revisions/latest |
GET | /api/v1/courses/:course_id/pages/:url/revisions/:revision_id | url:GET|/api/v1/courses/:course_id/pages/:url/revisions/:revision_id |
GET | /api/v1/groups/:group_id/pages/:url/revisions/:revision_id | url:GET|/api/v1/groups/:group_id/pages/:url/revisions/:revision_id |
POST | /api/v1/courses/:course_id/pages/:url/revisions/:revision_id | url:POST|/api/v1/courses/:course_id/pages/:url/revisions/:revision_id |
POST | /api/v1/groups/:group_id/pages/:url/revisions/:revision_id | url:POST|/api/v1/groups/:group_id/pages/:url/revisions/:revision_id |
POST | /api/v1/courses/:course_id/pages | url:POST|/api/v1/courses/:course_id/pages |
POST | /api/v1/groups/:group_id/pages | url:POST|/api/v1/groups/:group_id/pages |
PUT | /api/v1/courses/:course_id/pages/:url | url:PUT|/api/v1/courses/:course_id/pages/:url |
PUT | /api/v1/groups/:group_id/pages/:url | url:PUT|/api/v1/groups/:group_id/pages/:url |
DELETE | /api/v1/courses/:course_id/pages/:url | url:DELETE|/api/v1/courses/:course_id/pages/:url |
DELETE | /api/v1/groups/:group_id/pages/:url | url:DELETE|/api/v1/groups/:group_id/pages/:url |
Peer Reviews
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/courses/:course_id/assignments/:assignment_id/peer_reviews | url:GET|/api/v1/courses/:course_id/assignments/:assignment_id/peer_reviews |
GET | /api/v1/sections/:section_id/assignments/:assignment_id/peer_reviews | url:GET|/api/v1/sections/:section_id/assignments/:assignment_id/peer_reviews |
GET | /api/v1/courses/:course_id/assignments/:assignment_id/submissions/:submission_id/peer_reviews | url:GET|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:submission_id/peer_reviews |
GET | /api/v1/sections/:section_id/assignments/:assignment_id/submissions/:submission_id/peer_reviews | url:GET|/api/v1/sections/:section_id/assignments/:assignment_id/submissions/:submission_id/peer_reviews |
POST | /api/v1/courses/:course_id/assignments/:assignment_id/submissions/:submission_id/peer_reviews | url:POST|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:submission_id/peer_reviews |
POST | /api/v1/sections/:section_id/assignments/:assignment_id/submissions/:submission_id/peer_reviews | url:POST|/api/v1/sections/:section_id/assignments/:assignment_id/submissions/:submission_id/peer_reviews |
DELETE | /api/v1/courses/:course_id/assignments/:assignment_id/submissions/:submission_id/peer_reviews | url:DELETE|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:submission_id/peer_reviews |
DELETE | /api/v1/sections/:section_id/assignments/:assignment_id/submissions/:submission_id/peer_reviews | url:DELETE|/api/v1/sections/:section_id/assignments/:assignment_id/submissions/:submission_id/peer_reviews |
Plagiarism Detection Platform Assignments
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/courses/:course_id/assignments/:id | url:GET|/api/v1/courses/:course_id/assignments/:id |
Planner
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/planner/items | url:GET|/api/v1/planner/items |
Planner Note
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/planner_notes | url:GET|/api/v1/planner_notes |
GET | /api/v1/planner_notes/:id | url:GET|/api/v1/planner_notes/:id |
PUT | /api/v1/planner_notes/:id | url:PUT|/api/v1/planner_notes/:id |
POST | /api/v1/planner_notes | url:POST|/api/v1/planner_notes |
DELETE | /api/v1/planner_notes/:id | url:DELETE|/api/v1/planner_notes/:id |
Planner override
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/planner/overrides | url:GET|/api/v1/planner/overrides |
GET | /api/v1/planner/overrides/:id | url:GET|/api/v1/planner/overrides/:id |
PUT | /api/v1/planner/overrides/:id | url:PUT|/api/v1/planner/overrides/:id |
POST | /api/v1/planner/overrides | url:POST|/api/v1/planner/overrides |
DELETE | /api/v1/planner/overrides/:id | url:DELETE|/api/v1/planner/overrides/:id |
Progress
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/progress/:id | url:GET|/api/v1/progress/:id |
Roles
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/accounts/:account_id/roles | url:GET|/api/v1/accounts/:account_id/roles |
GET | /api/v1/accounts/:account_id/roles/:id | url:GET|/api/v1/accounts/:account_id/roles/:id |
POST | /api/v1/accounts/:account_id/roles | url:POST|/api/v1/accounts/:account_id/roles |
POST | /api/v1/accounts/:account_id/roles/:id/activate | url:POST|/api/v1/accounts/:account_id/roles/:id/activate |
PUT | /api/v1/accounts/:account_id/roles/:id | url:PUT|/api/v1/accounts/:account_id/roles/:id |
DELETE | /api/v1/accounts/:account_id/roles/:id | url:DELETE|/api/v1/accounts/:account_id/roles/:id |
Rubrics
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/accounts/:account_id/rubrics | url:GET|/api/v1/accounts/:account_id/rubrics |
GET | /api/v1/accounts/:account_id/rubrics/:id | url:GET|/api/v1/accounts/:account_id/rubrics/:id |
GET | /api/v1/courses/:course_id/rubrics | url:GET|/api/v1/courses/:course_id/rubrics |
GET | /api/v1/courses/:course_id/rubrics/:id | url:GET|/api/v1/courses/:course_id/rubrics/:id |
Search
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/conversations/find_recipients | url:GET|/api/v1/conversations/find_recipients |
GET | /api/v1/search/recipients | url:GET|/api/v1/search/recipients |
GET | /api/v1/search/all_courses | url:GET|/api/v1/search/all_courses |
Sections
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/courses/:course_id/sections | url:GET|/api/v1/courses/:course_id/sections |
GET | /api/v1/courses/:course_id/sections/:id | url:GET|/api/v1/courses/:course_id/sections/:id |
GET | /api/v1/sections/:id | url:GET|/api/v1/sections/:id |
POST | /api/v1/courses/:course_id/sections | url:POST|/api/v1/courses/:course_id/sections |
PUT | /api/v1/sections/:id | url:PUT|/api/v1/sections/:id |
DELETE | /api/v1/sections/:id | url:DELETE|/api/v1/sections/:id |
POST | /api/v1/sections/:id/crosslist/:new_course_id | url:POST|/api/v1/sections/:id/crosslist/:new_course_id |
DELETE | /api/v1/sections/:id/crosslist | url:DELETE|/api/v1/sections/:id/crosslist |
Services
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/services/kaltura | url:GET|/api/v1/services/kaltura |
POST | /api/v1/services/kaltura_session | url:POST|/api/v1/services/kaltura_session |
Shared Brand Configs
Verb | Endpoint | Scope |
---|---|---|
POST | /api/v1/accounts/:account_id/shared_brand_configs | url:POST|/api/v1/accounts/:account_id/shared_brand_configs |
PUT | /api/v1/accounts/:account_id/shared_brand_configs/:id | url:PUT|/api/v1/accounts/:account_id/shared_brand_configs/:id |
DELETE | /api/v1/shared_brand_configs/:id | url:DELETE|/api/v1/shared_brand_configs/:id |
SIS Import Errors
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/accounts/:account_id/sis_imports/:id/errors | url:GET|/api/v1/accounts/:account_id/sis_imports/:id/errors |
GET | /api/v1/accounts/:account_id/sis_import_errors | url:GET|/api/v1/accounts/:account_id/sis_import_errors |
SIS Imports
Verb | Endpoint | Scope |
---|---|---|
POST | /api/v1/accounts/:account_id/sis_imports | url:POST|/api/v1/accounts/:account_id/sis_imports |
PUT | /api/v1/accounts/:account_id/sis_imports/abort_all_pending | url:PUT|/api/v1/accounts/:account_id/sis_imports/abort_all_pending |
GET | /api/v1/accounts/:account_id/sis_imports/:id | url:GET|/api/v1/accounts/:account_id/sis_imports/:id |
GET | /api/v1/accounts/:account_id/sis_imports | url:GET|/api/v1/accounts/:account_id/sis_imports |
PUT | /api/v1/accounts/:account_id/sis_imports/:id/abort | url:PUT|/api/v1/accounts/:account_id/sis_imports/:id/abort |
PUT | /api/v1/accounts/:account_id/sis_imports/:id/restore_states | url:PUT|/api/v1/accounts/:account_id/sis_imports/:id/restore_states |
SIS Integration
Verb | Endpoint | Scope |
---|---|---|
GET | /api/sis/accounts/:account_id/assignments | url:GET|/api/sis/accounts/:account_id/assignments |
GET | /api/sis/courses/:course_id/assignments | url:GET|/api/sis/courses/:course_id/assignments |
PUT | /api/sis/courses/:course_id/disable_post_to_sis | url:PUT|/api/sis/courses/:course_id/disable_post_to_sis |
Submission Comments
Verb | Endpoint | Scope |
---|---|---|
POST | /api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id/comments/files | url:POST|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id/comments/files |
Submissions
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/courses/:course_id/assignments/gradeable_students | url:GET|/api/v1/courses/:course_id/assignments/gradeable_students |
POST | /api/v1/courses/:course_id/submissions/update_grades | url:POST|/api/v1/courses/:course_id/submissions/update_grades |
PUT | /api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id/read | url:PUT|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id/read |
DELETE | /api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id/read | url:DELETE|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id/read |
GET | /api/v1/courses/:course_id/assignments/:assignment_id/submissions | url:GET|/api/v1/courses/:course_id/assignments/:assignment_id/submissions |
GET | /api/v1/courses/:course_id/students/submissions | url:GET|/api/v1/courses/:course_id/students/submissions |
GET | /api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id | url:GET|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id |
POST | /api/v1/courses/:course_id/assignments/:assignment_id/submissions | url:POST|/api/v1/courses/:course_id/assignments/:assignment_id/submissions |
POST | /api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id/files | url:POST|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id/files |
PUT | /api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id | url:PUT|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/:user_id |
POST | /api/v1/courses/:course_id/assignments/:assignment_id/submissions/update_grades | url:POST|/api/v1/courses/:course_id/assignments/:assignment_id/submissions/update_grades |
GET | /api/v1/courses/:course_id/assignments/:assignment_id/submission_summary | url:GET|/api/v1/courses/:course_id/assignments/:assignment_id/submission_summary |
POST | /api/v1/sections/:section_id/submissions/update_grades | url:POST|/api/v1/sections/:section_id/submissions/update_grades |
PUT | /api/v1/sections/:section_id/assignments/:assignment_id/submissions/:user_id/read | url:PUT|/api/v1/sections/:section_id/assignments/:assignment_id/submissions/:user_id/read |
DELETE | /api/v1/sections/:section_id/assignments/:assignment_id/submissions/:user_id/read | url:DELETE|/api/v1/sections/:section_id/assignments/:assignment_id/submissions/:user_id/read |
GET | /api/v1/sections/:section_id/assignments/:assignment_id/submissions | url:GET|/api/v1/sections/:section_id/assignments/:assignment_id/submissions |
GET | /api/v1/sections/:section_id/students/submissions | url:GET|/api/v1/sections/:section_id/students/submissions |
GET | /api/v1/sections/:section_id/assignments/:assignment_id/submissions/:user_id | url:GET|/api/v1/sections/:section_id/assignments/:assignment_id/submissions/:user_id |
POST | /api/v1/sections/:section_id/assignments/:assignment_id/submissions | url:POST|/api/v1/sections/:section_id/assignments/:assignment_id/submissions |
POST | /api/v1/sections/:section_id/assignments/:assignment_id/submissions/:user_id/files | url:POST|/api/v1/sections/:section_id/assignments/:assignment_id/submissions/:user_id/files |
PUT | /api/v1/sections/:section_id/assignments/:assignment_id/submissions/:user_id | url:PUT|/api/v1/sections/:section_id/assignments/:assignment_id/submissions/:user_id |
POST | /api/v1/sections/:section_id/assignments/:assignment_id/submissions/update_grades | url:POST|/api/v1/sections/:section_id/assignments/:assignment_id/submissions/update_grades |
GET | /api/v1/sections/:section_id/assignments/:assignment_id/submission_summary | url:GET|/api/v1/sections/:section_id/assignments/:assignment_id/submission_summary |
GET | /api/v1/courses/:course_id/assignments/:assignment_id/gradeable_students | url:GET|/api/v1/courses/:course_id/assignments/:assignment_id/gradeable_students |
Tabs
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/courses/:course_id/tabs | url:GET|/api/v1/courses/:course_id/tabs |
GET | /api/v1/groups/:group_id/tabs | url:GET|/api/v1/groups/:group_id/tabs |
PUT | /api/v1/courses/:course_id/tabs/:tab_id | url:PUT|/api/v1/courses/:course_id/tabs/:tab_id |
User Observees
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/users/:user_id/observees | url:GET|/api/v1/users/:user_id/observees |
POST | /api/v1/users/:user_id/observees | url:POST|/api/v1/users/:user_id/observees |
GET | /api/v1/users/:user_id/observees/:observee_id | url:GET|/api/v1/users/:user_id/observees/:observee_id |
PUT | /api/v1/users/:user_id/observees/:observee_id | url:PUT|/api/v1/users/:user_id/observees/:observee_id |
DELETE | /api/v1/users/:user_id/observees/:observee_id | url:DELETE|/api/v1/users/:user_id/observees/:observee_id |
Users
Verb | Endpoint | Scope |
---|---|---|
GET | /api/v1/users/self/activity_stream | url:GET|/api/v1/users/self/activity_stream |
GET | /api/v1/users/activity_stream | url:GET|/api/v1/users/activity_stream |
GET | /api/v1/users/self/activity_stream/summary | url:GET|/api/v1/users/self/activity_stream/summary |
DELETE | /api/v1/users/self/activity_stream/:id | url:DELETE|/api/v1/users/self/activity_stream/:id |
DELETE | /api/v1/users/self/activity_stream | url:DELETE|/api/v1/users/self/activity_stream |
GET | /api/v1/users/self/todo | url:GET|/api/v1/users/self/todo |
GET | /api/v1/users/self/todo_item_count | url:GET|/api/v1/users/self/todo_item_count |
GET | /api/v1/users/self/upcoming_events | url:GET|/api/v1/users/self/upcoming_events |
GET | /api/v1/users/:user_id/missing_submissions | url:GET|/api/v1/users/:user_id/missing_submissions |
POST | /api/v1/accounts/:account_id/users | url:POST|/api/v1/accounts/:account_id/users |
POST | /api/v1/accounts/:account_id/self_registration | url:POST|/api/v1/accounts/:account_id/self_registration |
GET | /api/v1/accounts/:account_id/users | url:GET|/api/v1/accounts/:account_id/users |
GET | /api/v1/users/:id | url:GET|/api/v1/users/:id |
PUT | /api/v1/users/:id | url:PUT|/api/v1/users/:id |
POST | /api/v1/users/:user_id/files | url:POST|/api/v1/users/:user_id/files |
GET | /api/v1/users/:id/settings | url:GET|/api/v1/users/:id/settings |
PUT | /api/v1/users/:id/settings | url:PUT|/api/v1/users/:id/settings |
GET | /api/v1/users/:id/colors | url:GET|/api/v1/users/:id/colors |
GET | /api/v1/users/:id/colors/:asset_string | url:GET|/api/v1/users/:id/colors/:asset_string |
PUT | /api/v1/users/:id/colors/:asset_string | url:PUT|/api/v1/users/:id/colors/:asset_string |
GET | /api/v1/users/:id/dashboard_positions | url:GET|/api/v1/users/:id/dashboard_positions |
PUT | /api/v1/users/:id/dashboard_positions | url:PUT|/api/v1/users/:id/dashboard_positions |
PUT | /api/v1/users/:id/merge_into/:destination_user_id | url:PUT|/api/v1/users/:id/merge_into/:destination_user_id |
PUT | /api/v1/users/:id/merge_into/accounts/:destination_account_id/users/:destination_user_id | url:PUT|/api/v1/users/:id/merge_into/accounts/:destination_account_id/users/:destination_user_id |
POST | /api/v1/users/:id/split | url:POST|/api/v1/users/:id/split |
POST | /api/v1/users/self/pandata_events_token | url:POST|/api/v1/users/self/pandata_events_token |
GET | /api/v1/users/:user_id/custom_data(/*scope) | url:GET|/api/v1/users/:user_id/custom_data(/*scope) |
PUT | /api/v1/users/:user_id/custom_data(/*scope) | url:PUT|/api/v1/users/:user_id/custom_data(/*scope) |
DELETE | /api/v1/users/:user_id/custom_data(/*scope) | url:DELETE|/api/v1/users/:user_id/custom_data(/*scope) |
GET | /api/v1/users/:user_id/page_views | url:GET|/api/v1/users/:user_id/page_views |
GET | /api/v1/users/:user_id/profile | url:GET|/api/v1/users/:user_id/profile |
GET | /api/v1/users/:user_id/avatars | url:GET|/api/v1/users/:user_id/avatars |
GET | /api/v1/users/self/course_nicknames | url:GET|/api/v1/users/self/course_nicknames |
GET | /api/v1/users/self/course_nicknames/:course_id | url:GET|/api/v1/users/self/course_nicknames/:course_id |
PUT | /api/v1/users/self/course_nicknames/:course_id | url:PUT|/api/v1/users/self/course_nicknames/:course_id |
DELETE | /api/v1/users/self/course_nicknames/:course_id | url:DELETE|/api/v1/users/self/course_nicknames/:course_id |
DELETE | /api/v1/users/self/course_nicknames | url:DELETE|/api/v1/users/self/course_nicknames |