Skip to content

UserGroup

A user group, returns basic info about the user group

Fields

created_at · String! · required · The date the user group was created
cursor · Cursor! · required · Pagination cursor
doc_share_id · String · An ID used for document, course, and conversation sharing
id · ID! · required · The unique identifier of the user group
invite_code · String · The invite code
name · String · The name of the user group
onboarding_flow · OnboardingFlow · Onboarding Flow of this user group
onboarding_flow_id · String · The id of the associated onboarding flow
recurring_forms · [RecurringForm!] · Recurring Form Names for this user group
recurring_forms_count · Int · Recurring Forms Count for this user group
user · User · Owner of this user group
user_ids · [String] · ids of user in group
users · [User!]! · required · All patients associated with this user group.
users_count · Int · The number of users in the group
users_with_membership · [User!] · Users in user group with course membership

Used By

Definition

"""
A user group, returns basic info about the user group
"""
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.
"""
users(
"""
The active status of the users in the group. Can be "active" or "inactive"
"""
active_status: String
"""
The id of the conversation to filter users by
"""
convo_id: ID
"""
Sort the returned users by last name
"""
should_sort: Boolean = true
): [User!]!
"""
The number of users in the group
"""
users_count: Int
"""
Users in user group with course membership
"""
users_with_membership: [User!]
}