GET

To make a GET request, simply end with get(). This tells the library to make a GET request. This library uses the awesome Requests library so the return object in this case is simple a Response object. You will most often want the response as a json object. You get this by calling .json() with the Response.

# get a list of courses (paginated to 10) in the account
accounts_json = c.accounts('self').courses.get().json()

If you need to send query parameters (key-value pairs added after a question mark), add these as keyword parameters in the get() call. Let’s say you want a list of your own courses where you are a teacher and the enrollment is active. You would normally need to add ?enrollment_type=teacher&enrollment_state=active to the URL to do this. With the py_canvas_api library, however, you would do it like this.

# get a list of courses (paginated to 10) in the account
accounts_json = c.courses.get(enrollment_type='teacher', enrollment_state='active').json()

Here are several more GET examples.

# list of users
users = c.accounts('self').users.get().json()

# assignments in course with canvas id 23423
assignments = c.courses(23423).assignments.get().json()

# assignments in course with sis id ENG101
assignments = c.courses('sis_course_id:ENG101').assignments.get().json()

# list communication channels for user with id 82
channels = c.users(82).communication_channels.get().json()

# list own communication channels
channels = c.users('self').communication_channels.get().json()

# Get a list of all courses in the account. This will keep pulling results as
# long as there are more pages. It uses generator functions to do this is a
# smart way.
accounts = c.accounts('self').course.get_paginated()