Canvas LMS Files API
Course/user/group files and folders
Canvas LMS Files API is one of 16 APIs that Canvas LMS publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 2 JSON Schema definitions.
Tagged areas include Files. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, authentication docs, rate-limit docs, a changelog, and 2 JSON Schemas.
This API exposes 1 operation across 1 path, and defines 1 schema. It is described by OpenAPI 3.1.0, at version 1.0.
Requests are made against a single base URL, https://{canvas_host}/api/v1.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Canvas LMS Files API declares
2 security schemes
for authenticating requests.
It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 3 scopes.
It accepts HTTP bearer tokens (BearerAuth).
By default, every request must be authenticated.
OAuth2— Canvas OAuth2 (RFC 6749) authorization code grant. Register a Developer Key in the target Canvas account to obtain a clientid and clientsecret.BearerAuth— A Canvas access token. For testing only — production apps MUST use the OAuth2 flow per the Canvas API Policy.
Paths & Operations 1
Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.
Course/user/group files and folders
Schemas 1
The contract defines 1 schema that model the data the API accepts and returns. The most detailed is File (21 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Canvas LMS 12
Other APIs Canvas LMS publishes across the network.