Canvas
API actions for the Canvas integration.
Canvas
Connect Canvas to look up courses, assignments, and students, and to post course announcements.
Create Canvas announcement
Post a new announcement to a specific Canvas course.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
base_url | string | Yes | The web address of your Canvas site (for example, https://myschool.instructure.com). |
course_id | string | Yes | The Canvas course ID to post the announcement to. |
title | string | Yes | Title of the announcement. |
message | string | Yes | The content of the announcement. You can include HTML formatting. |
Response
{
"html_url": "https://myschool.instructure.com/courses/12345/discussion_topics/11111",
"id": 11111,
"message": "Class is cancelled tomorrow.",
"title": "Important Update"
}Get Canvas course details
Retrieve detailed information about a specific Canvas course by ID.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
base_url | string | Yes | The web address of your Canvas site (for example, https://myschool.instructure.com). |
course_id | string | Yes | The Canvas course ID to retrieve. |
Response
{
"course_code": "CS101",
"end_at": "2026-05-15T00:00:00Z",
"id": 12345,
"name": "Introduction to Computer Science",
"start_at": "2026-01-15T00:00:00Z",
"workflow_state": "available"
}List Canvas assignments
Retrieve all assignments for a specific Canvas course.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
base_url | string | Yes | The web address of your Canvas site (for example, https://myschool.instructure.com). |
course_id | string | Yes | The Canvas course ID to list assignments from. |
search_term | string | No | Optional search term to filter assignments. |
Response
[
{
"due_at": "2026-03-15T23:59:00Z",
"html_url": "https://myschool.instructure.com/courses/12345/assignments/67890",
"id": 67890,
"name": "Midterm Exam",
"points_possible": 100
}
]List Canvas courses
List all Canvas courses that your connected account can access.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
base_url | string | Yes | The web address of your Canvas site (for example, https://myschool.instructure.com). |
enrollment_state | string | No | Only include courses with this enrollment status, such as active or completed. |
Response
[
{
"course_code": "CS101",
"id": 12345,
"name": "Introduction to Computer Science",
"workflow_state": "available"
}
]List Canvas students
Retrieve all students enrolled in a specific Canvas course.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
base_url | string | Yes | The web address of your Canvas site (for example, https://myschool.instructure.com). |
course_id | string | Yes | The Canvas course ID to list students from. |
enrollment_state | string | No | Only include students with this enrollment status, such as active or invited. |
Response
[
{
"id": 99999,
"login_id": "jdoe@school.edu",
"name": "John Doe",
"sortable_name": "Doe, John"
}
]