{ "opencollection": "1.0.0", "info": { "name": "Canvas LMS REST Accounts API", "version": "1.0" }, "request": { "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://canvas.instructure.com/login/oauth2/auth", "accessTokenUrl": "https://canvas.instructure.com/login/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "items": [ { "info": { "name": "Accounts", "type": "folder" }, "items": [ { "info": { "name": "List Accounts", "type": "http" }, "http": { "method": "GET", "url": "https://{canvas_host}/api/v1/accounts", "params": [ { "name": "per_page", "value": "", "type": "query", "description": "Items per page (default 10, max varies by endpoint and install)." }, { "name": "page", "value": "", "type": "query", "description": "Page number (1-indexed). Prefer following RFC 5988 Link headers with rel=\"next\"." }, { "name": "include[]", "value": "", "type": "query" } ] }, "docs": "List accounts that the current user can view or manage." }, { "info": { "name": "Get a Single Account", "type": "http" }, "http": { "method": "GET", "url": "https://{canvas_host}/api/v1/accounts/:account_id", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Canvas account ID, an SIS account ID prefixed `sis_account_id:`, or `self`." } ] }, "docs": "Get a Single Account" }, { "info": { "name": "List Active Courses in an Account", "type": "http" }, "http": { "method": "GET", "url": "https://{canvas_host}/api/v1/accounts/:account_id/courses", "params": [ { "name": "account_id", "value": "", "type": "path", "description": "The Canvas account ID, an SIS account ID prefixed `sis_account_id:`, or `self`." }, { "name": "with_enrollments", "value": "", "type": "query" }, { "name": "enrollment_term_id", "value": "", "type": "query" }, { "name": "search_term", "value": "", "type": "query" }, { "name": "state[]", "value": "", "type": "query" }, { "name": "per_page", "value": "", "type": "query", "description": "Items per page (default 10, max varies by endpoint and install)." }, { "name": "page", "value": "", "type": "query", "description": "Page number (1-indexed). Prefer following RFC 5988 Link headers with rel=\"next\"." } ] }, "docs": "List Active Courses in an Account" } ] } ], "bundled": true }