# Canvas LMS

> Read Canvas courses, enrollments, assignments, submissions, modules and pages, and manage assignments and modules.

App · 20 actions. Web page: https://docs.lodol.com/docs/integrations/canvas-lms

## Actions

### Create assignment

Create assignment.

**Inputs**

- Course (`course_id`, text, required): ID
- Assignment name (`assignment_name`, text, required): The assignment name.
- Assignment points possible (`assignment_points_possible`, number): The maximum points possible on the assignment.
- Assignment grading type (`assignment_grading_type`, text): The strategy used for grading the assignment. The assignment defaults to "points" if this field is omitted. One of: `pass_fail`, `percent`, `letter_grade`, `gpa_scale`, `points`, `not_graded`.
- Assignment due at (`assignment_due_at`, date and time): The day/time the assignment is due. Must be between the lock dates if there are lock dates. Accepts times in ISO 8601 format, e.g. 2014-10-21T18:48:00Z.
- Assignment lock at (`assignment_lock_at`, date and time): The day/time the assignment is locked after. Must be after the due date if there is a due date. Accepts times in ISO 8601 format, e.g. 2014-10-21T18:48:00Z.
- Assignment unlock at (`assignment_unlock_at`, date and time): The day/time the assignment is unlocked. Must be before the due date if there is a due date. Accepts times in ISO 8601 format, e.g. 2014-10-21T18:48:00Z.
- Assignment description (`assignment_description`, text): The assignment's description, supports HTML.
- Assignment published (`assignment_published`, true/false): Whether this assignment is published. (Only useful if 'draft state' account setting is on) Unpublished assignments are not visible to students.
- Submission types (`assignment_submission_types`, list): List of supported submission types for the assignment. Unless the assignment is allowing online submissions, the array should only have one element. If not allowing online submissions, your options are: "online_quiz" "none" "on_paper" "discussion_topic" "external_tool" If you are allowing online submissions, you can have one or many allowed submission types: "online_upload" "online_text_entry" "online_url" "media_recording" (Only valid when the Kaltura plugin is enabled) "student_annotation". One or more of: `online_quiz`, `none`, `on_paper`, `discussion_topic`, `external_tool`, `online_upload`, `online_text_entry`, `online_url`, `media_recording`, `student_annotation`.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Create module

Create module.

**Inputs**

- Course (`course_id`, text, required): ID
- Module name (`module_name`, text, required): The name of the module
- Module unlock at (`module_unlock_at`, date and time): The date the module will unlock
- Module publish final grade (`module_publish_final_grade`, true/false): Whether to publish the student's final grade for the course upon completion of this module.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Create page

Create page.

**Inputs**

- Course (`course_id`, text, required): ID
- Title (`title`, text, required): The page title.
- Content (`body`, text): Page content as HTML.
- Published (`published`, true/false): Whether students can see this page.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Delete assignment

Delete assignment.

**Inputs**

- Course (`course_id`, text, required): ID
- Id (`id`, text, required): ID

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Delete module

Delete module.

**Inputs**

- Course (`course_id`, text, required): ID
- Id (`id`, text, required): ID

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Delete page

Delete page.

**Inputs**

- Course (`course_id`, text, required): ID
- Url or id (`url_or_id`, text, required): ID

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Enroll user

Enroll user.

**Inputs**

- Course (`course_id`, text, required): ID
- Enrollment user id (`enrollment_user_id`, text, required): The ID of the user to be enrolled in the course.
- Enrollment type (`enrollment_type`, text, required): Enroll the user as a student, teacher, TA, observer, or designer. If no value is given, the type will be inferred by +enrollment[role]+ if supplied, otherwise 'StudentEnrollment' will be used. One of: `StudentEnrollment`, `TeacherEnrollment`, `TaEnrollment`, `ObserverEnrollment`, `DesignerEnrollment`.
- Enrollment enrollment state (`enrollment_enrollment_state`, text): If set to 'active,' student will be immediately enrolled in the course. Otherwise they will be required to accept a course invitation. Default is 'invited.'. If set to 'inactive', student will be listed in the course roster for teachers, but will not be able to participate in the course until their enrollment is activated. One of: `active`, `invited`, `inactive`.
- Enrollment notify (`enrollment_notify`, true/false): If true, a notification will be sent to the enrolled user. Notifications are not sent by default.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Get assignment

Get assignment.

**Inputs**

- Course (`course_id`, text, required): ID
- Id (`id`, text, required): ID

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Get course

Get course.

**Inputs**

- Id (`id`, text, required): ID

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Get module

Get module.

**Inputs**

- Course (`course_id`, text, required): ID
- Id (`id`, text, required): ID

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Get page

Get page.

**Inputs**

- Course (`course_id`, text, required): ID
- Url or id (`url_or_id`, text, required): ID

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### Get submission

Get submission.

**Inputs**

- Course (`course_id`, text, required): ID
- Assignment (`assignment_id`, text, required): ID
- User id (`record_user_id`, text, required): ID

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```

### List assignments

List assignments. Returns one page; use the continuation value for more records.

**Inputs**

- Course (`course_id`, text, required): ID
- Search term (`search_term`, text): The partial title of the assignments to match and return.
- Page (`page`, number): Page number from the previous result. At least 1.
- Per page (`per_page`, number): Records per page. Canvas can cap this value. At least 1.

**Outputs**: Result.

- `data` (list): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}
```

### List course users

List course users. Returns one page; use the continuation value for more records.

**Inputs**

- Course (`course_id`, text, required): ID
- Search term (`search_term`, text): The partial name or full ID of the users to match and return in the results list.
- Enrollment type (`enrollment_type`, list): When set, only return users where the user is enrolled as this type. "student_view" implies include[]=test_student. This argument is ignored if enrollment_role is given. One or more of: `teacher`, `student`, `student_view`, `ta`, `observer`, `designer`.
- Enrollment state (`enrollment_state`, list): When set, only return users where the enrollment workflow state is of one of the given types. "active" and "invited" enrollments are returned by default. One or more of: `active`, `invited`, `rejected`, `completed`, `inactive`.
- Page (`page`, number): Page number from the previous result. At least 1.
- Per page (`per_page`, number): Records per page. Canvas can cap this value. At least 1.

**Outputs**: Result.

- `data` (list): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}
```

### List courses

List courses. Returns one page; use the continuation value for more records.

**Inputs**

- Enrollment type (`enrollment_type`, text): When set, only return courses where the user is enrolled as this type. For example, set to "teacher" to return only courses where the user is enrolled as a Teacher. This argument is ignored if enrollment_role is given. One of: `teacher`, `student`, `ta`, `observer`, `designer`.
- Enrollment state (`enrollment_state`, text): When set, only return courses where the user has an enrollment with the given state. This will respect section/course/term date overrides. One of: `active`, `invited_or_pending`, `completed`.
- Page (`page`, number): Page number from the previous result. At least 1.
- Per page (`per_page`, number): Records per page. Canvas can cap this value. At least 1.

**Outputs**: Result.

- `data` (list): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}
```

### List enrollments

List enrollments. Returns one page; use the continuation value for more records.

**Inputs**

- Course (`course_id`, text, required): ID
- Type (`type`, list): A list of enrollment types to return. Accepted values are 'StudentEnrollment', 'TeacherEnrollment', 'TaEnrollment', 'DesignerEnrollment', and 'ObserverEnrollment.' If omitted, all enrollment types are returned. This argument is ignored if `role` is given.
- Page (`page`, number): Page number from the previous result. At least 1.
- Per page (`per_page`, number): Records per page. Canvas can cap this value. At least 1.

**Outputs**: Result.

- `data` (list): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}
```

### List modules

List modules. Returns one page; use the continuation value for more records.

**Inputs**

- Course (`course_id`, text, required): ID
- Search term (`search_term`, text): The partial name of the modules (and module items, if 'items' is specified with include[]) to match and return.
- Page (`page`, number): Page number from the previous result. At least 1.
- Per page (`per_page`, number): Records per page. Canvas can cap this value. At least 1.

**Outputs**: Result.

- `data` (list): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}
```

### List pages

List pages. Returns one page; use the continuation value for more records.

**Inputs**

- Course (`course_id`, text, required): ID
- Search term (`search_term`, text): The partial title of the pages to match and return.
- Page (`page`, number): Page number from the previous result. At least 1.
- Per page (`per_page`, number): Records per page. Canvas can cap this value. At least 1.

**Outputs**: Result.

- `data` (list): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}
```

### List submissions

List submissions. Returns one page; use the continuation value for more records.

**Inputs**

- Course (`course_id`, text, required): ID
- Assignment (`assignment_id`, text, required): ID
- Page (`page`, number): Page number from the previous result. At least 1.
- Per page (`per_page`, number): Records per page. Canvas can cap this value. At least 1.

**Outputs**: Result.

- `data` (list): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": [],
  "has_more": false,
  "next_cursor": null
}
```

### Update assignment

Update assignment.

**Inputs**

- Course (`course_id`, text, required): ID
- Id (`id`, text, required): ID
- Assignment name (`assignment_name`, text): The assignment name.
- Assignment points possible (`assignment_points_possible`, number): The maximum points possible on the assignment.
- Assignment grading type (`assignment_grading_type`, text): The strategy used for grading the assignment. The assignment defaults to "points" if this field is omitted. One of: `pass_fail`, `percent`, `letter_grade`, `gpa_scale`, `points`, `not_graded`.
- Assignment due at (`assignment_due_at`, date and time): The day/time the assignment is due. Accepts times in ISO 8601 format, e.g. 2014-10-21T18:48:00Z.
- Assignment lock at (`assignment_lock_at`, date and time): The day/time the assignment is locked after. Must be after the due date if there is a due date. Accepts times in ISO 8601 format, e.g. 2014-10-21T18:48:00Z.
- Assignment unlock at (`assignment_unlock_at`, date and time): The day/time the assignment is unlocked. Must be before the due date if there is a due date. Accepts times in ISO 8601 format, e.g. 2014-10-21T18:48:00Z.
- Assignment description (`assignment_description`, text): The assignment's description, supports HTML.
- Assignment published (`assignment_published`, true/false): Whether this assignment is published. (Only useful if 'draft state' account setting is on) Unpublished assignments are not visible to students.
- Submission types (`assignment_submission_types`, list): List of supported submission types for the assignment. Unless the assignment is allowing online submissions, the array should only have one element. If not allowing online submissions, your options are: "online_quiz" "none" "on_paper" "discussion_topic" "external_tool" If you are allowing online submissions, you can have one or many allowed submission types: "online_upload" "online_text_entry" "online_url" "media_recording" (Only valid when the Kaltura plugin is enabled) "student_annotation". One or more of: `online_quiz`, `none`, `on_paper`, `discussion_topic`, `external_tool`, `online_upload`, `online_text_entry`, `online_url`, `media_recording`, `student_annotation`.

**Outputs**: Result.

- `data` (object): Complete service response.
- `has_more` (true/false): Whether another page is available.
- `next_cursor` (text): Continuation value for the next page.

**Example output**

```json
{
  "data": {},
  "has_more": false,
  "next_cursor": null
}
```
