OBJECT

UserGroup

A user group, returns basic info about the user group

GraphQL Schema definition

type UserGroup {
#   The date the user group was created
created_at: String! 
#   Pagination cursor
cursor: Cursor! 
#   An ID used for document, course, and conversation sharing
doc_share_id: String 
#   The unique identifier of the user group
id: ID! 
#   The invite code
invite_code: String 
#   The name of the user group
name: String 
#   Onboarding Flow of this user group
onboarding_flow: OnboardingFlow 
#   The id of the associated onboarding flow
onboarding_flow_id: String 
#   Recurring Form Names for this user group
recurring_forms: [RecurringForm!] 
#   Recurring Forms Count for this user group
recurring_forms_count: Int 
#   Owner of this user group
user: User 
#   ids of user in group
user_ids: [String] 
#   All patients associated with this user group.
# 
# Arguments
#   active_status: The active status of the users in the group. Can 
#   be "active" or "inactive"
#   convo_id: The id of the conversation to filter users by
#   should_sort: Sort the returned users by last name
users(active_status: String, convo_id: ID, should_sort: Boolean): [User!]! 
#   The number of users in the group
users_count: Int 
#   Users in user group with course membership
users_with_membership: [User!] 
}

UserGroup

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by