Canvas LMS GraphQL API

The Canvas LMS GraphQL API is an alternative to the REST API that lets clients request exactly the fields they need across Canvas resources in a single request. It is well suited for dashboards and aggregated views that otherwise require many REST round-trips.

API entry from apis.yml

apis.yml Raw ↑
aid: canvas:canvas-lms-graphql-api
name: Canvas LMS GraphQL API
description: The Canvas LMS GraphQL API is an alternative to the REST API that lets clients request exactly
  the fields they need across Canvas resources in a single request. It is well suited for dashboards and
  aggregated views that otherwise require many REST round-trips.
humanURL: https://canvas.instructure.com/doc/api/file.graphql.html
tags:
- Education
- GraphQL
- LMS
properties:
- type: Documentation
  url: https://canvas.instructure.com/doc/api/file.graphql.html
- url: graphql/canvas-graphql.md
  type: GraphQL
x-features:
- Typed GraphQL schema over Canvas resources
- Single-request fetches across courses, users, and assignments
- Reduced over-fetching for dashboards
- OAuth 2.0 bearer-token authentication
x-use-cases:
- Building performant student or instructor dashboards
- Aggregating course, assignment, and grade data in one request
- Mobile apps with limited bandwidth