# Courses
{% hint style="warning" %}
**Welcome to Our New API Docs!** This is the new home for all things API (previously at [Canvas LMS REST API Documentation](https://api.instructure.com)).
{% endhint %}
## Courses API
API for accessing course information.
**A Term object looks like:**
```js
{
"id": 1,
"name": "Default Term",
"start_at": "2012-06-01T00:00:00-06:00",
"end_at": null
}
```
**A CourseProgress object looks like:**
```js
{
// total number of requirements from all modules
"requirement_count": 10,
// total number of requirements the user has completed from all modules
"requirement_completed_count": 1,
// url to next module item that has an unmet requirement. null if the user has
// completed the course or the current module does not require sequential
// progress
"next_requirement_url": "http://localhost/courses/1/modules/items/2",
// date the course was completed. null if the course has not been completed by
// this user
"completed_at": "2013-06-01T00:00:00-06:00"
}
```
**A Course object looks like:**
```js
{
// the unique identifier for the course
"id": 370663,
// the SIS identifier for the course, if defined. This field is only included if
// the user has permission to view SIS information.
"sis_course_id": null,
// the UUID of the course
"uuid": "WvAHhY5FINzq5IyRIJybGeiXyFkG3SqHUPb7jZY5",
// the integration identifier for the course, if defined. This field is only
// included if the user has permission to view SIS information.
"integration_id": null,
// the unique identifier for the SIS import. This field is only included if the
// user has permission to manage SIS information.
"sis_import_id": 34,
// the full name of the course. If the requesting user has set a nickname for
// the course, the nickname will be shown here.
"name": "InstructureCon 2012",
// the course code
"course_code": "INSTCON12",
// the actual course name. This field is returned only if the requesting user
// has set a nickname for the course.
"original_name": "InstructureCon-2012-01",
// the current state of the course, also known as ‘status’. The value will be
// one of the following values: 'unpublished', 'available', 'completed', or
// 'deleted'. NOTE: When fetching a singular course that has a 'deleted'
// workflow state value, an error will be returned with a message of 'The
// specified resource does not exist.'
"workflow_state": "available",
// the account associated with the course
"account_id": 81259,
// the root account associated with the course
"root_account_id": 81259,
// the enrollment term associated with the course
"enrollment_term_id": 34,
// A list of grading periods associated with the course
"grading_periods": null,
// the grading standard associated with the course
"grading_standard_id": 25,
// the grade_passback_setting set on the course
"grade_passback_setting": "nightly_sync",
// the date the course was created.
"created_at": "2012-05-01T00:00:00-06:00",
// the start date for the course, if applicable
"start_at": "2012-06-01T00:00:00-06:00",
// the end date for the course, if applicable
"end_at": "2012-09-01T00:00:00-06:00",
// the course-set locale, if applicable
"locale": "en",
// A list of enrollments linking the current user to the course. for student
// enrollments, grading information may be included if include[]=total_scores
"enrollments": null,
// optional: the total number of active and invited students in the course
"total_students": 32,
// course calendar
"calendar": null,
// the type of page that users will see when they first visit the course -
// 'feed': Recent Activity Dashboard - 'wiki': Wiki Front Page - 'modules':
// Course Modules/Sections Page - 'assignments': Course Assignments List -
// 'syllabus': Course Syllabus Page other types may be added in the future
"default_view": "feed",
// optional: user-generated HTML for the course syllabus
"syllabus_body": "syllabus html goes here
",
// optional: the number of submissions needing grading returned only if the
// current user has grading rights and include[]=needs_grading_count
"needs_grading_count": 17,
// optional: the enrollment term object for the course returned only if
// include[]=term
"term": null,
// optional: information on progress through the course returned only if
// include[]=course_progress
"course_progress": null,
// weight final grade based on assignment group percentages
"apply_assignment_group_weights": true,
// optional: the permissions the user has for the course. returned only for a
// single course and include[]=permissions
"permissions": {"create_discussion_topic":true,"create_announcement":true},
"is_public": true,
"is_public_to_auth_users": true,
"public_syllabus": true,
"public_syllabus_to_auth": true,
// optional: the public description of the course
"public_description": "Come one, come all to InstructureCon 2012!",
"storage_quota_mb": 5,
"storage_quota_used_mb": 5,
"hide_final_grades": false,
"license": "Creative Commons",
"allow_student_assignment_edits": false,
"allow_wiki_comments": false,
"allow_student_forum_attachments": false,
"open_enrollment": true,
"self_enrollment": false,
"restrict_enrollments_to_course_dates": false,
"course_format": "online",
// optional: this will be true if this user is currently prevented from viewing
// the course because of date restriction settings
"access_restricted_by_date": false,
// The course's IANA time zone name.
"time_zone": "America/Denver",
// optional: whether the course is set as a Blueprint Course (blueprint fields
// require the Blueprint Courses feature)
"blueprint": true,
// optional: Set of restrictions applied to all locked course objects
"blueprint_restrictions": {"content":true,"points":true,"due_dates":false,"availability_dates":false},
// optional: Sets of restrictions differentiated by object type applied to
// locked course objects
"blueprint_restrictions_by_object_type": {"assignment":{"content":true,"points":true},"wiki_page":{"content":true}},
// optional: whether the course is set as a template (requires the Course
// Templates feature)
"template": true
}
```
**A CalendarLink object looks like:**
```js
{
// The URL of the calendar in ICS format
"ics": "https://canvas.instructure.com/feeds/calendars/course_abcdef.ics"
}
```
### [List your courses](#method.courses.index)
[CoursesController#index](https://github.com/instructure/canvas-lms/blob/master/app/controllers/courses_controller.rb)
**`GET /api/v1/courses`**
**Scope:** `url:GET|/api/v1/courses`
Returns the paginated list of active courses for the current user.
**Request Parameters:**
| Parameter | Type | Description |
| --------------------------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `enrollment_type` | `string` | 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.
Allowed values: teacher, student, ta, observer, designer
|
| `enrollment_role` | `string` | Deprecated When set, only return courses where the user is enrolled with the specified course-level role. This can be a role created with the [Add Role API](https://developerdocs.instructure.com/services/canvas/roles#method.role_overrides.add_role) or a base role type of ‘StudentEnrollment’, ‘TeacherEnrollment’, ‘TaEnrollment’, ‘ObserverEnrollment’, or ‘DesignerEnrollment’. |
| `enrollment_role_id` | `integer` | When set, only return courses where the user is enrolled with the specified course-level role. This can be a role created with the [Add Role API](https://developerdocs.instructure.com/services/canvas/roles#method.role_overrides.add_role) or a built\_in role type of ‘StudentEnrollment’, ‘TeacherEnrollment’, ‘TaEnrollment’, ‘ObserverEnrollment’, or ‘DesignerEnrollment’. |
| `enrollment_state` | `string` | When set, only return courses where the user has an enrollment with the given state. This will respect section/course/term date overrides.
Allowed values: active, invited\_or\_pending, completed
|
| `exclude_blueprint_courses` | `boolean` | When set, only return courses that are not configured as blueprint courses. |
| `include[]` | `string` |
“needs\_grading\_count”: Optional information to include with each Course. When needs\_grading\_count is given, and the current user has grading rights, the total number of submissions needing grading for all assignments is returned.
“syllabus\_body”: Optional information to include with each Course. When syllabus\_body is given the user-generated html for the course syllabus is returned.
“public\_description”: Optional information to include with each Course. When public\_description is given the user-generated text for the course public description is returned.
“total\_scores”: Optional information to include with each Course. When total\_scores is given, any student enrollments will also include the fields ‘computed\_current\_score’, ‘computed\_final\_score’, ‘computed\_current\_grade’, and ‘computed\_final\_grade’, as well as (if the user has permission) ‘unposted\_current\_score’, ‘unposted\_final\_score’, ‘unposted\_current\_grade’, and ‘unposted\_final\_grade’ (see Enrollment documentation for more information on these fields). This argument is ignored if the course is configured to hide final grades.
“current\_grading\_period\_scores”: Optional information to include with each Course. When current\_grading\_period\_scores is given and total\_scores is given, any student enrollments will also include the fields ‘has\_grading\_periods’, ‘totals\_for\_all\_grading\_periods\_option’, ‘current\_grading\_period\_title’, ‘current\_grading\_period\_id’, current\_period\_computed\_current\_score’, ‘current\_period\_computed\_final\_score’, ‘current\_period\_computed\_current\_grade’, and ‘current\_period\_computed\_final\_grade’, as well as (if the user has permission) ‘current\_period\_unposted\_current\_score’, ‘current\_period\_unposted\_final\_score’, ‘current\_period\_unposted\_current\_grade’, and ‘current\_period\_unposted\_final\_grade’ (see Enrollment documentation for more information on these fields). In addition, when this argument is passed, the course will have a ‘has\_grading\_periods’ attribute on it. This argument is ignored if the total\_scores argument is not included. If the course is configured to hide final grades, the following fields are not returned: ‘totals\_for\_all\_grading\_periods\_option’, ‘current\_period\_computed\_current\_score’, ‘current\_period\_computed\_final\_score’, ‘current\_period\_computed\_current\_grade’, ‘current\_period\_computed\_final\_grade’, ‘current\_period\_unposted\_current\_score’, ‘current\_period\_unposted\_final\_score’, ‘current\_period\_unposted\_current\_grade’, and ‘current\_period\_unposted\_final\_grade’
“grading\_periods”: Optional information to include with each Course. When grading\_periods is given, a list of the grading periods associated with each course is returned.
“term”: Optional information to include with each Course. When term is given, the information for the enrollment term for each course is returned.
“account”: Optional information to include with each Course. When account is given, the account json for each course is returned.
“course\_progress”: Optional information to include with each Course. When course\_progress is given, each course will include a ‘course\_progress’ object with the fields: ‘requirement\_count’, an integer specifying the total number of requirements in the course, ‘requirement\_completed\_count’, an integer specifying the total number of requirements in this course that have been completed, and ‘next\_requirement\_url’, a string url to the next requirement item, and ‘completed\_at’, the date the course was completed (null if incomplete). ‘next\_requirement\_url’ will be null if all requirements have been completed or the current module does not require sequential progress. “course\_progress” will return an error message if the course is not module based or the user is not enrolled as a student in the course.
“sections”: Section enrollment information to include with each Course. Returns an array of hashes containing the section ID (id), section name (name), start and end dates (start\_at, end\_at), as well as the enrollment type (enrollment\_role, e.g. ‘StudentEnrollment’).
“storage\_quota\_used\_mb”: The amount of storage space used by the files in this course
“total\_students”: Optional information to include with each Course. Returns an integer for the total amount of active and invited students.
“passback\_status”: Include the grade passback\_status
“favorites”: Optional information to include with each Course. Indicates if the user has marked the course as a favorite course.
“teachers”: Teacher information to include with each Course. Returns an array of hashes containing the UserDisplay information for each teacher in the course.
“observed\_users”: Optional information to include with each Course. Will include data for observed users if the current user has an observer enrollment.
“tabs”: Optional information to include with each Course. Will include the list of tabs configured for each course. See the List available tabs API for more information.
“course\_image”: Optional information to include with each Course. Returns course image url if a course image has been set.
“banner\_image”: Optional information to include with each Course. Returns course banner image url if the course is a Canvas for Elementary subject and a banner image has been set.
“concluded”: Optional information to include with each Course. Indicates whether the course has been concluded, taking course and term dates into account.
“post\_manually”: Optional information to include with each Course. Returns true if the course post policy is set to Manually post grades. Returns false if the the course post policy is set to Automatically post grades.
Allowed values: needs\_grading\_count, syllabus\_body, public\_description, total\_scores, current\_grading\_period\_scores, grading\_periods, term, account, course\_progress, sections, storage\_quota\_used\_mb, total\_students, passback\_status, favorites, teachers, observed\_users, course\_image, banner\_image, concluded, post\_manually
|
| `state[]` | `string` | If set, only return courses that are in the given state(s). By default, “available” is returned for students and observers, and anything except “deleted”, for all other enrollment types
Allowed values: unpublished, available, completed, deleted
|
Returns a list of [Course](#course) objects.
### [List courses for a user](#method.courses.user_index)
[CoursesController#user\_index](https://github.com/instructure/canvas-lms/blob/master/app/controllers/courses_controller.rb)
**`GET /api/v1/users/:user_id/courses`**
**Scope:** `url:GET|/api/v1/users/:user_id/courses`
Returns a paginated list of active courses for this user. To view the course list for a user other than yourself, you must be either an observer of that user or an administrator.
**Request Parameters:**
| Parameter | Type | Description |
| ------------------ | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `include[]` | `string` |
“needs\_grading\_count”: Optional information to include with each Course. When needs\_grading\_count is given, and the current user has grading rights, the total number of submissions needing grading for all assignments is returned.
“syllabus\_body”: Optional information to include with each Course. When syllabus\_body is given the user-generated html for the course syllabus is returned.
“public\_description”: Optional information to include with each Course. When public\_description is given the user-generated text for the course public description is returned.
“total\_scores”: Optional information to include with each Course. When total\_scores is given, any student enrollments will also include the fields ‘computed\_current\_score’, ‘computed\_final\_score’, ‘computed\_current\_grade’, and ‘computed\_final\_grade’ (see Enrollment documentation for more information on these fields). This argument is ignored if the course is configured to hide final grades.
“current\_grading\_period\_scores”: Optional information to include with each Course. When current\_grading\_period\_scores is given and total\_scores is given, any student enrollments will also include the fields ‘has\_grading\_periods’, ‘totals\_for\_all\_grading\_periods\_option’, ‘current\_grading\_period\_title’, ‘current\_grading\_period\_id’, current\_period\_computed\_current\_score’, ‘current\_period\_computed\_final\_score’, ‘current\_period\_computed\_current\_grade’, and ‘current\_period\_computed\_final\_grade’, as well as (if the user has permission) ‘current\_period\_unposted\_current\_score’, ‘current\_period\_unposted\_final\_score’, ‘current\_period\_unposted\_current\_grade’, and ‘current\_period\_unposted\_final\_grade’ (see Enrollment documentation for more information on these fields). In addition, when this argument is passed, the course will have a ‘has\_grading\_periods’ attribute on it. This argument is ignored if the course is configured to hide final grades or if the total\_scores argument is not included.
“grading\_periods”: Optional information to include with each Course. When grading\_periods is given, a list of the grading periods associated with each course is returned.
“term”: Optional information to include with each Course. When term is given, the information for the enrollment term for each course is returned.
“account”: Optional information to include with each Course. When account is given, the account json for each course is returned.
“course\_progress”: Optional information to include with each Course. When course\_progress is given, each course will include a ‘course\_progress’ object with the fields: ‘requirement\_count’, an integer specifying the total number of requirements in the course, ‘requirement\_completed\_count’, an integer specifying the total number of requirements in this course that have been completed, and ‘next\_requirement\_url’, a string url to the next requirement item, and ‘completed\_at’, the date the course was completed (null if incomplete). ‘next\_requirement\_url’ will be null if all requirements have been completed or the current module does not require sequential progress. “course\_progress” will return an error message if the course is not module based or the user is not enrolled as a student in the course.
“sections”: Section enrollment information to include with each Course. Returns an array of hashes containing the section ID (id), section name (name), start and end dates (start\_at, end\_at), as well as the enrollment type (enrollment\_role, e.g. ‘StudentEnrollment’).
“storage\_quota\_used\_mb”: The amount of storage space used by the files in this course
“total\_students”: Optional information to include with each Course. Returns an integer for the total amount of active and invited students.
“passback\_status”: Include the grade passback\_status
“favorites”: Optional information to include with each Course. Indicates if the user has marked the course as a favorite course.
“teachers”: Teacher information to include with each Course. Returns an array of hashes containing the UserDisplay information for each teacher in the course.
“observed\_users”: Optional information to include with each Course. Will include data for observed users if the current user has an observer enrollment.
“tabs”: Optional information to include with each Course. Will include the list of tabs configured for each course. See the List available tabs API for more information.
“course\_image”: Optional information to include with each Course. Returns course image url if a course image has been set.
“banner\_image”: Optional information to include with each Course. Returns course banner image url if the course is a Canvas for Elementary subject and a banner image has been set.
“concluded”: Optional information to include with each Course. Indicates whether the course has been concluded, taking course and term dates into account.
“post\_manually”: Optional information to include with each Course. Returns true if the course post policy is set to “Manually”. Returns false if the the course post policy is set to “Automatically”.
Allowed values: needs\_grading\_count, syllabus\_body, public\_description, total\_scores, current\_grading\_period\_scores, grading\_periods, term, account, course\_progress, sections, storage\_quota\_used\_mb, total\_students, passback\_status, favorites, teachers, observed\_users, course\_image, banner\_image, concluded, post\_manually
|
| `state[]` | `string` | If set, only return courses that are in the given state(s). By default, “available” is returned for students and observers, and anything except “deleted”, for all other enrollment types
Allowed values: unpublished, available, completed, deleted
|
| `enrollment_state` | `string` | When set, only return courses where the user has an enrollment with the given state. This will respect section/course/term date overrides.
Allowed values: active, invited\_or\_pending, completed
|
| `homeroom` | `boolean` | If set, only return homeroom courses. |
| `account_id` | `string` | If set, only include courses associated with this account |
Returns a list of [Course](#course) objects.
### [Get user progress](#method.courses.user_progress)
[CoursesController#user\_progress](https://github.com/instructure/canvas-lms/blob/master/app/controllers/courses_controller.rb)
**`GET /api/v1/courses/:course_id/users/:user_id/progress`**
**Scope:** `url:GET|/api/v1/courses/:course_id/users/:user_id/progress`
Return progress information for the user and course
You can supply `self` as the user\_id to query your own progress in a course. To query another user’s progress, you must be a teacher in the course, an administrator, or a linked observer of the user.
Returns a [CourseProgress](#courseprogress) object.
### [Create a new course](#method.courses.create)
[CoursesController#create](https://github.com/instructure/canvas-lms/blob/master/app/controllers/courses_controller.rb)
**`POST /api/v1/accounts/:account_id/courses`**
**Scope:** `url:POST|/api/v1/accounts/:account_id/courses`
Create a new course
**Request Parameters:**
| Parameter | Type | Description |
| ---------------------------------------------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `course[name]` | `string` | The name of the course. If omitted, the course will be named “Unnamed Course.” |
| `course[course_code]` | `string` | The course code for the course. |
| `course[start_at]` | `DateTime` | Course start date in ISO8601 format, e.g. 2011-01-01T01:00Z This value is ignored unless ‘restrict\_enrollments\_to\_course\_dates’ is set to true. |
| `course[end_at]` | `DateTime` | Course end date in ISO8601 format. e.g. 2011-01-01T01:00Z This value is ignored unless ‘restrict\_enrollments\_to\_course\_dates’ is set to true. |
| `course[license]` | `string` | The name of the licensing. Should be one of the following abbreviations (a descriptive name is included in parenthesis for reference):
‘private’ (Private Copyrighted)
‘cc\_by\_nc\_nd’ (CC Attribution Non-Commercial No Derivatives)
‘cc\_by\_nc\_sa’ (CC Attribution Non-Commercial Share Alike)
‘cc\_by\_nc’ (CC Attribution Non-Commercial)
‘cc\_by\_nd’ (CC Attribution No Derivatives)
‘cc\_by\_sa’ (CC Attribution Share Alike)
‘cc\_by’ (CC Attribution)
‘public\_domain’ (Public Domain).
|
| `course[is_public]` | `boolean` | Set to true if course is public to both authenticated and unauthenticated users. |
| `course[is_public_to_auth_users]` | `boolean` | Set to true if course is public only to authenticated users. |
| `course[public_syllabus]` | `boolean` | Set to true to make the course syllabus public. |
| `course[public_syllabus_to_auth]` | `boolean` | Set to true to make the course syllabus public for authenticated users. |
| `course[public_description]` | `string` | A publicly visible description of the course. |
| `course[allow_student_wiki_edits]` | `boolean` | If true, students will be able to modify the course wiki. |
| `course[allow_wiki_comments]` | `boolean` | If true, course members will be able to comment on wiki pages. |
| `course[allow_student_forum_attachments]` | `boolean` | If true, students can attach files to forum posts. |
| `course[open_enrollment]` | `boolean` | Set to true if the course is open enrollment. |
| `course[self_enrollment]` | `boolean` | Set to true if the course is self enrollment. |
| `course[restrict_enrollments_to_course_dates]` | `boolean` | Set to true to restrict user enrollments to the start and end dates of the course. This value must be set to true in order to specify a course start date and/or end date. |
| `course[term_id]` | `string` | The unique ID of the term to create to course in. |
| `course[sis_course_id]` | `string` | The unique SIS identifier. |
| `course[integration_id]` | `string` | The unique Integration identifier. |
| `course[hide_final_grades]` | `boolean` | If this option is set to true, the totals in student grades summary will be hidden. |
| `course[apply_assignment_group_weights]` | `boolean` | Set to true to weight final grade based on assignment groups percentages. |
| `course[time_zone]` | `string` | The time zone for the course. Allowed time zones are [IANA time zones](http://www.iana.org/time-zones) or friendlier [Ruby on Rails time zones](http://api.rubyonrails.org/classes/ActiveSupport/TimeZone.html). |
| `offer` | `boolean` | If this option is set to true, the course will be available to students immediately. |
| `enroll_me` | `boolean` | Set to true to enroll the current user as the teacher. |
| `skip_course_template` | `boolean` | If this option is set to true, the template of the account will not be applied to this course It means copy\_from\_course\_template will not be executed. This option is thought for a course copy. |
| `course[default_view]` | `string` | The type of page that users will see when they first visit the course
‘feed’ Recent Activity Dashboard
‘modules’ Course Modules/Sections Page
‘assignments’ Course Assignments List
‘syllabus’ Course Syllabus Page
other types may be added in the future
Allowed values: feed, wiki, modules, syllabus, assignments
|
| `course[syllabus_body]` | `string` | The syllabus body for the course |
| `course[grading_standard_id]` | `integer` | The grading standard id to set for the course. If no value is provided for this argument the current grading\_standard will be un-set from this course. |
| `course[grade_passback_setting]` | `string` | Optional. The grade\_passback\_setting for the course. Only ‘nightly\_sync’, ‘disabled’, and ” are allowed |
| `course[course_format]` | `string` | Optional. Specifies the format of the course. (Should be ‘on\_campus’, ‘online’, or ‘blended’) |
| `course[post_manually]` | `boolean` | Default is false. When true, all grades in the course must be posted manually, and will not be automatically posted. When false, all grades in the course will be automatically posted. |
| `enable_sis_reactivation` | `boolean` | When true, will first try to re-activate a deleted course with matching sis\_course\_id if possible. |
Returns a [Course](#course) object.
### [Upload a file](#method.courses.create_file)
[CoursesController#create\_file](https://github.com/instructure/canvas-lms/blob/master/app/controllers/courses_controller.rb)
**`POST /api/v1/courses/:course_id/files`**
**Scope:** `url:POST|/api/v1/courses/:course_id/files`
Upload a file to the course.
This API endpoint is the first step in uploading a file to a course. See the [File Upload Documentation](https://developerdocs.instructure.com/services/canvas/basics/file.file_uploads) for details on the file upload workflow.
Only those with the “Manage Files” permission on a course can upload files to the course. By default, this is Teachers, TAs and Designers.
### [List students](#method.courses.students)
[CoursesController#students](https://github.com/instructure/canvas-lms/blob/master/app/controllers/courses_controller.rb)
**`GET /api/v1/courses/:course_id/students`**
**Scope:** `url:GET|/api/v1/courses/:course_id/students`
Returns the paginated list of students enrolled in this course.
DEPRECATED: Please use the [course users](#method.courses.users) endpoint and pass “student” as the enrollment\_type.
Returns a list of [User](https://developerdocs.instructure.com/services/canvas/users#user) objects.
### [List users in course](#method.courses.users)
[CoursesController#users](https://github.com/instructure/canvas-lms/blob/master/app/controllers/courses_controller.rb)
**`GET /api/v1/courses/:course_id/users`**
**Scope:** `url:GET|/api/v1/courses/:course_id/users`
**`GET /api/v1/courses/:course_id/search_users`**
**Scope:** `url:GET|/api/v1/courses/:course_id/search_users`
Returns the paginated list of users in this course. And optionally the user’s enrollments in the course.
**Request Parameters:**
| Parameter | Type | Description |
| -------------------- | --------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `search_term` | `string` | The partial name or full ID of the users to match and return in the results list. |
| `sort` | `string` | When set, sort the results of the search based on the given field.
Allowed values: username, last\_login, email, sis\_id
|
| `enrollment_type[]` | `string` | 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.
Allowed values: teacher, student, student\_view, ta, observer, designer
|
| `enrollment_role` | `string` | Deprecated When set, only return users enrolled with the specified course-level role. This can be a role created with the [Add Role API](https://developerdocs.instructure.com/services/canvas/roles#method.role_overrides.add_role) or a base role type of ‘StudentEnrollment’, ‘TeacherEnrollment’, ‘TaEnrollment’, ‘ObserverEnrollment’, or ‘DesignerEnrollment’. |
| `enrollment_role_id` | `integer` | When set, only return courses where the user is enrolled with the specified course-level role. This can be a role created with the [Add Role API](https://developerdocs.instructure.com/services/canvas/roles#method.role_overrides.add_role) or a built\_in role id with type ‘StudentEnrollment’, ‘TeacherEnrollment’, ‘TaEnrollment’, ‘ObserverEnrollment’, or ‘DesignerEnrollment’. |
| `section_ids[]` | `integer` | When set, only return users who are enrolled in the given section(s). |
| `include[]` | `string` |
Optionally include with each Course the user’s current and invited enrollments. If the user is enrolled as a student, and the account has permission to manage or view all grades, each enrollment will include a ‘grades’ key with ‘current\_score’, ‘final\_score’, ‘current\_grade’ and ‘final\_grade’ values.
“locked”: Optionally include whether an enrollment is locked.
“avatar\_url”: Optionally include avatar\_url.
“bio”: Optionally include each user’s bio.
“test\_student”: Optionally include the course’s Test Student,
if present. Default is to not include Test Student.
such as analytics information
well as this directive, the scores returned in the enrollment will be for the current grading period if there is one. A ‘grading\_period\_id’ value will also be included with the scores. if grading\_period\_id is nil there is no current grading period and the score is a total score.
Allowed values: enrollments, locked, avatar\_url, test\_student, bio, custom\_links, current\_grading\_period\_scores, uuid
|
| `user_id` | `string` | If this parameter is given and it corresponds to a user in the course, the `page` parameter will be ignored and the page containing the specified user will be returned instead. |
| `user_ids[]` | `integer` | If included, the course users set will only include users with IDs specified by the param. Note: this will not work in conjunction with the “user\_id” argument but multiple user\_ids can be included. |
| `enrollment_state[]` | `string` | 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.
Allowed values: active, invited, rejected, completed, inactive
|
Returns a list of [User](https://developerdocs.instructure.com/services/canvas/users#user) objects.
### [List recently logged in students](#method.courses.recent_students)
[CoursesController#recent\_students](https://github.com/instructure/canvas-lms/blob/master/app/controllers/courses_controller.rb)
**`GET /api/v1/courses/:course_id/recent_students`**
**Scope:** `url:GET|/api/v1/courses/:course_id/recent_students`
Returns the paginated list of users in this course, ordered by how recently they have logged in. The records include the ‘last\_login’ field which contains a timestamp of the last time that user logged into canvas. The querying user must have the ‘View usage reports’ permission.
**Example Request:**
```bash
curl -H 'Authorization: Bearer ' \
https://