userGroups

Cursor-paginated user groups owned by the current user.

Arguments

keywords · String · Search over user group name. Blank values are ignored.

course_id · ID · If provided, exclude user groups already enrolled in this course

check_group_level_actions · Boolean · Return no groups unless the current user's organization membership allows group level actions

order_by · UserGroupOrderKeys · Sort order key for the returned user groups.

sort_by · String · Deprecated. A value that matches an order key takes precedence over `order_by`; any other value is ignored.

after · String · Returns the elements in the list that come after the specified cursor.

before · String · Returns the elements in the list that come before the specified cursor.

first · Int · Returns the first _n_ elements from the list.

last · Int · Returns the last _n_ elements from the list.

Returns

UserGroupPaginationConnection

Example

query userGroups(
  $keywords: String
  $course_id: ID
  $check_group_level_actions: Boolean
  $order_by: UserGroupOrderKeys
  $sort_by: String
  $after: String
  $before: String
  $first: Int
  $last: Int
) {
  userGroups(
    keywords: $keywords
    course_id: $course_id
    check_group_level_actions: $check_group_level_actions
    order_by: $order_by
    sort_by: $sort_by
    after: $after
    before: $before
    first: $first
    last: $last
  ) {
    edges
    nodes
    page_info
    total_count
  }
}