Skip to content
API Docs

OnboardingFlow

An onboarding flow that is comprised of onboarding items

Fields

created_at · String! · required · The date this onboarding flow was created
cursor · Cursor! · required · Pagination cursor
has_forms_after_welcome · Boolean · If true, the flow has more froms after welcome
id · ID! · required · The unique identifier of the flow
is_multiple_providers · Boolean · Check if current user organization has more than 1 provider
name · String · The name of this onboarding flow
onboarding_items · [OnboardingItem!]! · required · All onboarding items that make up the onboarding flow
onboarding_items_count · Int · The number of onboarding items in the flow
user · User · Owner of this onboarding flow
user_groups · [UserGroup!] · The user groups this onboarding flow is associated with
user_groups_count · Int · The number of user groups this onboarding flow is associated with
user_groups_name_string · String · The combined name list of the user groups this onboarding flow is associated with

Used By

Definition 

"""
An onboarding flow that is comprised of onboarding items
"""
type OnboardingFlow {
  """
  The date this onboarding flow was created
  """
  created_at: String!


  """
  Pagination cursor
  """
  cursor: Cursor!


  """
  If true, the flow has more froms after welcome
  """
  has_forms_after_welcome: Boolean


  """
  The unique identifier of the flow
  """
  id: ID!


  """
  Check if current user organization has more than 1 provider
  """
  is_multiple_providers: Boolean


  """
  The name of this onboarding flow
  """
  name: String


  """
  All onboarding items that make up the onboarding flow
  """
  onboarding_items(
    """
    If true, only return custom module forms
    """
    custom_module_forms_only: Boolean = false
  ): [OnboardingItem!]!


  """
  The number of onboarding items in the flow
  """
  onboarding_items_count: Int


  """
  Owner of this onboarding flow
  """
  user: User


  """
  The user groups this onboarding flow is associated with
  """
  user_groups: [UserGroup!]


  """
  The number of user groups this onboarding flow is associated with
  """
  user_groups_count: Int


  """
  The combined name list of the user groups this onboarding flow is associated with
  """
  user_groups_name_string: String
}