How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Canvas Groups API

The Groups API from Canvas — 17 operation(s) for groups.

Canvas Groups API is one of 145 APIs that Canvas publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Group. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, a GitHub repository, an API reference, and rate-limit docs.

This API exposes 25 operations across 17 paths, and defines 2 schemas. It is described by OpenAPI 3.2.0, at version v1.

Requests are made against 2 base URLs: https://canvas.instructure.com/api, https://{canvas_host}/api.

25 operations 17 paths 2 schemas 4 DELETE12 GET6 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1
Base URL
https://canvas.instructure.com/api/v1
Authentication
HTTP Bearer, OAuth 2.0
License
Resource Areas
1

Authentication & Security 2

Canvas Groups API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). It supports OAuth 2.0 (oauth2) using the authorizationCode flow. By default, every request must be authenticated.

  • bearerAuth — Canvas OAuth2 access token sent as "Authorization: Bearer ". See https://canvas.instructure.com/doc/api/file.oauth.html
  • oauth2 — Canvas OAuth2. See https://canvas.instructure.com/doc/api/file.oauth.html and https://canvas.instructure.com/doc/api/file.oauthendpoints.html

Paths & Operations 25

Across 17 paths, the API surfaces 25 operations — 4 DELETE, 12 GET, 6 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Groups 25
POST
/v1/groups/{group_id}/files
Upload a file
upload_file_groups 1 param → 200
POST
/v1/group_categories/{group_category_id}/groups
Create a group
create_group_group_categories 1 param body → 200
GET
/v1/users/self/groups
List your groups
list_your_groups 2 params → 200
GET
/v1/accounts/{account_id}/groups
List the groups available in a context
list_groups_available_in_context_accounts 4 params → 200
GET
/v1/courses/{course_id}/groups
List the groups available in a context
list_groups_available_in_context_courses 4 params → 200
GET
/v1/courses/{course_id}/bulk_user_tags
Bulk fetch user tags for multiple users in a course
bulk_fetch_user_tags_for_multiple_users_in_course 2 params → 200
GET
/v1/groups/{group_id}
Get a single group
get_single_group 2 params → 200
PUT
/v1/groups/{group_id}
Edit a group
edit_group 1 param body → 200
DELETE
/v1/groups/{group_id}
Delete a group
delete_group 1 param → 200
POST
/v1/groups
Create a group
create_group_groups body → 200
POST
/v1/groups/{group_id}/invite
Invite others to a group
invite_others_to_group 1 param body → 200
GET
/v1/groups/{group_id}/users
List group's users
list_group_s_users 4 params → 200
DELETE
/v1/groups/{group_id}/users
Bulk delete memberships Bulk deletes memberships by providing an array of user…
bulk_delete_memberships_bulk_deletes_memberships_by_providing_array_of_user_ids_or_for_differentiation_tag_groups_by_providing_all_in_group_course_to_remove_every_course_student_matching_optional_role_tag_filter 6 params → 200
POST
/v1/groups/{group_id}/preview_html
Preview processed html
preview_processed_html_groups 1 param body → 200
GET
/v1/groups/{group_id}/activity_stream
Group activity stream
group_activity_stream 1 param → 200
GET
/v1/groups/{group_id}/activity_stream/summary
Group activity stream summary
group_activity_stream_summary 1 param → 200
GET
/v1/groups/{group_id}/permissions
Permissions
permissions_groups 2 params → 200
GET
/v1/groups/{group_id}/memberships
List group memberships
list_group_memberships 2 params → 200
POST
/v1/groups/{group_id}/memberships
Create a membership
create_membership 1 param body → 200
GET
/v1/groups/{group_id}/memberships/{membership_id}
Get a single group membership
get_single_group_membership_memberships 2 params → 200
PUT
/v1/groups/{group_id}/memberships/{membership_id}
Update a membership
update_membership_memberships 2 params body → 200
DELETE
/v1/groups/{group_id}/memberships/{membership_id}
Leave a group
leave_group_memberships 2 params → 200
GET
/v1/groups/{group_id}/users/{user_id}
Get a single group membership
get_single_group_membership_users 2 params → 200
PUT
/v1/groups/{group_id}/users/{user_id}
Update a membership
update_membership_users 2 params body → 200
DELETE
/v1/groups/{group_id}/users/{user_id}
Leave a group
leave_group_users 2 params → 200

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Group (20 properties), GroupMembership (7 properties). Each schema is shown below with its type and property counts.

GroupMembership
object
7 properties
Group
object
20 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

canvas-groups-api-openapi.yml Raw ↑

Other APIs Canvas publishes across the network.

Canvas LMS GraphQL API
Canvas LTI Integrations
Canvas Courses API
Canvas Access Tokens API
Canvas Accessibility Course Scans API
Canvas Accessibility Course Statistics API
Canvas Account Calendars API
Canvas Account Domain Lookups API
Canvas Account Notifications API
Canvas Account Reports API
Canvas Accounts API
Canvas Accounts (Lti) API
Where this information came from

This is an independent, third-party profile of Canvas Groups API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.