userGroups

Fetch paginated user groups collection

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.

offset · Int · Page offset, applied when should_paginate is true

should_paginate · Boolean · Enables pagination if true

page_size · Int · The number of user groups to return per page when should_paginate is true

after · Cursor · Cursor to fetch results after

Returns

[UserGroup!]

Example

query userGroups(
  $keywords: String
  $course_id: ID
  $check_group_level_actions: Boolean
  $order_by: UserGroupOrderKeys
  $sort_by: String
  $offset: Int
  $should_paginate: Boolean
  $page_size: Int
  $after: Cursor
) {
  userGroups(
    keywords: $keywords
    course_id: $course_id
    check_group_level_actions: $check_group_level_actions
    order_by: $order_by
    sort_by: $sort_by
    offset: $offset
    should_paginate: $should_paginate
    page_size: $page_size
    after: $after
  ) {
    created_at
    cursor
    doc_share_id
    id
    invite_code
    name
    onboarding_flow
    onboarding_flow_id
    recurring_forms
    recurring_forms_count
    user
    user_ids
    users
    users_count
    users_with_membership
  }
}