usersCount

Number of users

Arguments

active_status · String

conversation_id · ID

convo_patients_only · Boolean

expect_conversation_id · Boolean · When this is true, but conversation_id is nil, we return no users

group_id · String

has_cc_on_file · Boolean · When true, only clients with credit cards will be returned. Passing false does nothing

keywords · String

limited_to_provider · Boolean

include_suborg_patients · Boolean

provider_id · String

show_all_by_default · Boolean · when false, 0 is returned unless keywords or a conversation_id are provided

tag_ids · [ID] · When passed in, only clients with at least ONE of the passed-in tags will be returned.

Returns

Int

Example

query usersCount(
  $active_status: String
  $conversation_id: ID
  $convo_patients_only: Boolean
  $expect_conversation_id: Boolean
  $group_id: String
  $has_cc_on_file: Boolean
  $keywords: String
  $limited_to_provider: Boolean
  $include_suborg_patients: Boolean
  $provider_id: String
  $show_all_by_default: Boolean
  $tag_ids: [ID]
) {
  usersCount(
    active_status: $active_status
    conversation_id: $conversation_id
    convo_patients_only: $convo_patients_only
    expect_conversation_id: $expect_conversation_id
    group_id: $group_id
    has_cc_on_file: $has_cc_on_file
    keywords: $keywords
    limited_to_provider: $limited_to_provider
    include_suborg_patients: $include_suborg_patients
    provider_id: $provider_id
    show_all_by_default: $show_all_by_default
    tag_ids: $tag_ids
  )
}