Skip to contents

This is especially useful for getting users in all groups within a Group Set, known as group_category_id in the Canvas docs for groups.

Usage

canvas_groups_users()

Value

A tibble with information about groups and their members.

  • group_id: The ID of the group.

  • group_name: The name of the group.

  • group_category_id: The ID of the group category.

  • members_count: The number of members in the group.

  • user_id: The ID of the user.

  • name: The name of the user.

  • created_at: The date and time the user was created.

  • sortable_name: The sortable name of the user.

  • short_name: The short name of the user.

  • sis_user_id: The SIS ID of the user.

  • login_id: The login ID of the user.

Details

This is similar to the functionality of rcanvas::get_course_user_groups()

Examples

if (FALSE) { # \dontrun{
gu <- canvas_groups_users()
print(gu)
} # }