userGroups

Fetch paginated user groups collection

Arguments

after · Cursor · Cursor to fetch results after

keywords · String

offset · Int

should_paginate · Boolean

sort_by · String

order_by · UserGroupOrderKeys

page_size · Int

check_group_level_actions · Boolean · checks the allow_group_level_actions permission on org membership

Returns

[UserGroup!]

Example

query userGroups(
  $after: Cursor
  $keywords: String
  $offset: Int
  $should_paginate: Boolean
  $sort_by: String
  $order_by: UserGroupOrderKeys
  $page_size: Int
  $check_group_level_actions: Boolean
) {
  userGroups(
    after: $after
    keywords: $keywords
    offset: $offset
    should_paginate: $should_paginate
    sort_by: $sort_by
    order_by: $order_by
    page_size: $page_size
    check_group_level_actions: $check_group_level_actions
  ) {
    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
  }
}