Canvas List Course Users

• pageinteger
  Page number to fetch (1-indexed). Use to get results beyond the first page.
• sortstring
  The field to sort the list of users by. Results are sorted in ascending order.
• includearray
  Specifies additional details to include for each user in the response (e.g., 'enrollments', 'avatar_url').
• user_idstring
  If provided, the response will be paginated to the page where this specific user ID appears. Useful for finding a user within a large list.
• per_pageinteger
  Number of users to return per page (max 100). Higher values fetch more data in a single request.
• user_idsarray
  A list of user IDs to filter the results. Only users whose IDs are in this list will be returned.
• course_idstring

  Required
  The unique identifier for the Canvas course from which to list users.
• search_termstring
  A partial name or full ID to filter users. If provided, only users matching the search term will be returned.
• enrollment_rolestring
  Deprecated: Filters users by a specific course-level role name. Use `enrollment_role_id` instead for better precision.
• enrollment_typearray
  Filters the list to include only users with the specified enrollment types (e.g., 'student', 'teacher').
• enrollment_statearray
  Filters the list to include only users with the specified enrollment states (e.g., 'active', 'invited').
• enrollment_role_idstring
  Filters the list to include only users enrolled with the specified course-level role ID.

• data

  Required
  Data from the action execution
• errorstring
  Error if any occurred during the execution of the action
• successfulboolean

  Required
  Whether or not the action execution was successful or not

No verified related use cases are linked yet.

No published Skills explicitly reference this Action yet.