Canvas API: Complete Guide with Examples

API Overview

Canvas API Authentication

Generate an Access Token

1. Log in to Canvas
2. Go to Account → Settings
3. Scroll to Approved Integrations
4. Click "+ New Access Token"
5. Enter a purpose (e.g., "API Integration") and optional expiry
6. Click "Generate Token"
7. Copy the token immediately — it won't be shown again

Use the Token

bash# Authorization header (recommended)
curl -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  https://yourschool.instructure.com/api/v1/courses

Key Canvas API Endpoints

Courses

Users

Enrollments

Assignments

Quizzes

Submissions & Grades

Modules

Code Examples

Python: List All Courses

pythonimport requests

CANVAS_URL = "https://yourschool.instructure.com"
TOKEN = "your_access_token"

headers = {"Authorization": f"Bearer {TOKEN}"}

response = requests.get(
    f"{CANVAS_URL}/api/v1/courses",
    headers=headers,
    params={"per_page": 100}
)

courses = response.json()
for course in courses:
    print(f"{course['id']}: {course['name']}")

Python: Create a User

pythonresponse = requests.post(
    f"{CANVAS_URL}/api/v1/accounts/1/users",
    headers=headers,
    json={
        "user": {
            "name": "Jane Smith",
            "short_name": "Jane",
            "sortable_name": "Smith, Jane"
        },
        "pseudonym": {
            "unique_id": "[email protected]",
            "password": "SecurePass123!"
        }
    }
)

user = response.json()
print(f"Created user: {user['id']} - {user['name']}")

Python: Enroll a User in a Course

pythonresponse = requests.post(
    f"{CANVAS_URL}/api/v1/courses/5/enrollments",
    headers=headers,
    json={
        "enrollment": {
            "user_id": user["id"],
            "type": "StudentEnrollment",
            "enrollment_state": "active"
        }
    }
)

print(f"Enrolled: {response.json()['id']}")

Node.js: List Assignments

javascriptconst CANVAS_URL = 'https://yourschool.instructure.com';
const TOKEN = process.env.CANVAS_TOKEN;

async function getAssignments(courseId) {
  const response = await fetch(
    `${CANVAS_URL}/api/v1/courses/${courseId}/assignments?per_page=100`,
    { headers: { 'Authorization': `Bearer ${TOKEN}` } }
  );
  return response.json();
}

const assignments = await getAssignments(5);
assignments.forEach(a => console.log(`${a.id}: ${a.name} (${a.points_possible} pts)`));

cURL: Create a Quiz

bashcurl -X POST "https://yourschool.instructure.com/api/v1/courses/5/quizzes" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "quiz": {
      "title": "Chapter 5 Quiz",
      "description": "Test your knowledge of Chapter 5",
      "quiz_type": "assignment",
      "time_limit": 30,
      "allowed_attempts": 2,
      "scoring_policy": "keep_highest",
      "published": false
    }
  }'

Handling Pagination

pythondef get_all_pages(url, headers):
    results = []
    while url:
        response = requests.get(url, headers=headers)
        results.extend(response.json())
        # Parse Link header for next page
        links = response.headers.get('Link', '')
        url = None
        for link in links.split(','):
            if 'rel="next"' in link:
                url = link.split(';')[0].strip('<> ')
    return results

all_users = get_all_pages(
    f"{CANVAS_URL}/api/v1/courses/5/users?per_page=100",
    headers
)

Rate Limits

Creating Quizzes: Canvas API vs Formswrite

bash# Formswrite: Convert Google Doc to Canvas QTI
curl -X POST https://api.formswrite.com/api/v1/convert \
  -H "Authorization: Bearer FORMSWRITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"documentId": "DOC_ID", "format": "canvas"}'

Canvas API Documentation

• Official API docs: canvas.instructure.com/doc/api
• Live API explorer: Your Canvas instance → /doc/api/live
• GitHub: github.com/instructure/canvas-lms

FAQ

How do I get a Canvas API token?

What is the Canvas API rate limit?

Can I create quiz questions via the Canvas API?

Is the Canvas API free?

Does Canvas support GraphQL?

Summary