Canvas

Canvas Users API

The Users API from Canvas — 38 operation(s) for users.

GitHub OpenAPI

Operations 48

GET /v1/accounts/{account_id}/users List users in account #
POST /v1/accounts/{account_id}/users Create a user #
POST /v1/users/{user_id}/files Upload a file #
GET /v1/users/self/activity_stream List the activity stream #
DELETE /v1/users/self/activity_stream Hide all stream items #
GET /v1/users/activity_stream List the activity stream #
GET /v1/users/self/activity_stream/summary Activity stream summary #
GET /v1/users/self/todo List the TODO items #
GET /v1/users/self/todo_item_count List counts for todo items #
GET /v1/users/self/upcoming_events List upcoming assignments, calendar events #
GET /v1/users/{user_id}/missing_submissions List Missing Submissions #
DELETE /v1/users/self/activity_stream/{id} Hide a stream item #
GET /v1/users/{id} Show user details #
PUT /v1/users/{id} Edit a user #
POST /v1/accounts/{account_id}/self_registration [DEPRECATED] Self register a user #
GET /v1/users/{id}/settings Update user settings #
GET /v1/users/{id}/colors Get custom colors #
GET /v1/users/{id}/colors/{asset_string} Get custom color #
PUT /v1/users/{id}/colors/{asset_string} Update custom color #
PUT /v1/users/{id}/text_editor_preference Update text editor preference #
PUT /v1/users/{id}/files_ui_version_preference Update files UI version preference #
GET /v1/users/{id}/dashboard_positions Get dashboard positions #
PUT /v1/users/{id}/dashboard_positions Update dashboard positions #
DELETE /v1/users/{id}/sessions Terminate all user sessions #
DELETE /v1/users/mobile_sessions Log users out of all mobile apps #
DELETE /v1/users/{id}/mobile_sessions Log users out of all mobile apps #
PUT /v1/users/{id}/merge_into/{destination_user_id} Merge user into another user #
PUT /v1/users/{id}/merge_into/accounts/{destination_account_id}/users/{destination_user_id} Merge user into another user #
POST /v1/users/{id}/split Split merged users into separate users #
POST /v1/users/self/pandata_events_token Get a Pandata Events jwt token and its expiration date #
GET /v1/users/{id}/graded_submissions Get a users most recently graded submissions #
GET /v1/users/{user_id}/profile Get user profile #
GET /v1/users/{user_id}/avatars List avatar options #
GET /v1/users/{user_id}/page_views List user page views #
POST /v1/users/{user_id}/page_views/query BETA - Initiate page views query #
GET /v1/users/{user_id}/page_views/query/{query_id} BETA - Poll query status #
GET /v1/users/{user_id}/page_views/query/{query_id}/results BETA - Get query results #
POST /v1/users/page_views/query BETA - Initiate batch page views query #
GET /v1/users/page_views/query/{query_id} BETA - Poll batch query status #
GET /v1/users/page_views/query/{query_id}/results BETA - Get batch query results #
PUT /v1/users/{user_id}/custom_data Store custom data #
GET /v1/users/{user_id}/custom_data Load custom data #
DELETE /v1/users/{user_id}/custom_data Delete custom data #
GET /v1/users/self/course_nicknames List course nicknames #
DELETE /v1/users/self/course_nicknames Clear course nicknames #
GET /v1/users/self/course_nicknames/{course_id} Get course nickname #
PUT /v1/users/self/course_nicknames/{course_id} Set course nickname #
DELETE /v1/users/self/course_nicknames/{course_id} Remove course nickname #

Documentation

📖
Documentation
https://canvas.instructure.com/doc/api/
📖
Authentication
https://canvas.instructure.com/doc/api/file.oauth.html
📖
APIReference
https://canvas.instructure.com/doc/api/
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/canvas/refs/heads/main/rate-limits/canvas-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/canvas/refs/heads/main/openapi/canvas-users-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/instructure/canvas-lms

Other Resources

🔗
Pagination
https://canvas.instructure.com/doc/api/file.pagination.html
🔗
Swagger
https://canvas.instructure.com/doc/api/api-docs.json
🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/canvas/refs/heads/main/scopes/canvas-scopes.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/canvas/refs/heads/main/errors/canvas-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/canvas/refs/heads/main/data-model/canvas-data-model.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/canvas-users-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

canvas-users-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Canvas LMS REST Users API
  version: v1
  summary: The complete Canvas LMS REST API, converted from the Swagger 1.2 documents Instructure publishes under https://canvas.instructure.com/doc/api/.
  description: The Canvas LMS REST API covers courses, assignments, quizzes, grades, users, enrollments, accounts, files, modules, rubrics, submissions, SIS imports, LTI, analytics and account administration.
  contact:
    name: Instructure Canvas
    url: https://canvas.instructure.com/doc/api/
  license:
    name: AGPL-3.0
    url: https://github.com/instructure/canvas-lms/blob/master/LICENSE
servers:
- url: https://canvas.instructure.com/api
  description: Instructure-hosted Canvas (canvas.instructure.com)
- url: https://{canvas_host}/api
  description: Any Canvas instance; Canvas is multi-tenant and self-hostable, so the host is the institution's Canvas domain.
  variables:
    canvas_host:
      default: canvas.instructure.com
      description: Your institution's Canvas hostname, e.g. school.instructure.com
security:
- bearerAuth: []
- oauth2: []
tags:


# --- truncated at 32 KB (118 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/canvas/refs/heads/main/openapi/canvas-users-api-openapi.yml