Skip to content
For LLMsView as Markdown·

Canvas LMS ​

Manage courses, students, and assignments in the Canvas learning management system.

DetailValue
CategoryEducation
Base URLhttps://canvas.instructure.com/api/v1
AuthenticationBearer Token
Endpoints3
Connector keycanvas-lms

Using Canvas LMS in a workflow ​

  1. Go to Connections and click New Connection.
  2. Pick Canvas LMS from the marketplace.
  3. Enter your credentials (see Authentication above for what's expected).
  4. In a workflow, drop an API Call node and select this connection.
  5. Pick the operation you need from the Operation dropdown. The full list is below.

Available endpoints ​

EndpointSummary
GET /coursesList courses
GET /courses/{id}/studentsList students in a course
POST /courses/{id}/assignmentsCreate an assignment

Each endpoint is documented in full below. Use the outline on the right to jump to one.

GET /courses ​

List courses

DetailValue
Operation IDeducation.listCourses
MethodGET
Path/courses

Parameters ​

NameLocationTypeRequired
per_pagequeryintegerNo

Using this endpoint in a workflow ​

  1. Add an API Call node to your workflow.
  2. Pick your Canvas LMS connection from the Connection dropdown.
  3. In the Operation dropdown, select education.listCourses.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

What it returns ​

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Canvas LMS API reference.

GET /courses/{id}/students ​

List students in a course

DetailValue
Operation IDeducation.listStudents
MethodGET
Path/courses/{id}/students

Parameters ​

NameLocationTypeRequired
idpathstringYes

Using this endpoint in a workflow ​

  1. Add an API Call node to your workflow.
  2. Pick your Canvas LMS connection from the Connection dropdown.
  3. In the Operation dropdown, select education.listStudents.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked: fill them or the call will fail at runtime.

What it returns ​

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Canvas LMS API reference.

POST /courses/{id}/assignments ​

Create an assignment

DetailValue
Operation IDeducation.createAssignment
MethodPOST
Path/courses/{id}/assignments

Parameters ​

NameLocationTypeRequired
idpathstringYes

Request Body ​

FieldType
assignmentobject

Using this endpoint in a workflow ​

  1. Add an API Call node to your workflow.
  2. Pick your Canvas LMS connection from the Connection dropdown.
  3. In the Operation dropdown, select education.createAssignment.
  4. Fill in the parameter fields that appear. Use {{...}} to reference upstream values.

Required fields are marked: fill them or the call will fail at runtime.

What it returns ​

The API Call node writes the response to the workflow context:

{
  status: 200,
  success: true,
  data: { ...response body from the API... },
  latencyMs: 142
}

Reference response fields downstream as {{nodeId.data.path}}. The exact response shape is documented on the upstream Canvas LMS API reference.