Skip to content
Healthie API Docs

users

Fetch paginated patients collection (use organizationMembers query for providers)

Arguments

active_status · String · Possible options: [active, archived]
email · String · Does nothing
expect_conversation_id · Boolean · When this is true, but conversation_id is nil, we return no users
has_cc_on_file · Boolean · When true, only clients with credit cards will be returned. Passing false does nothing
show_all_by_default · Boolean · when false, an empty collection is returned unless keywords or a conversation_id are provided
sort_by · String · Options are email, first_name_asc, first_name_desc, last_name_asc, last_name_desc, created_at_desc, created_at_asc, updated_at_desc, updated_at_asc, group_name_asc, group_name_desc, provider_name_asc, provider_name_desc, next_appt_asc, next_appt_desc. Defaults to last_name_desc
tag_ids · [ID] · When passed in, only clients with at least ONE of the passed-in tags will be returned.
after · String · Returns the elements in the list that come after the specified cursor.
before · String · Returns the elements in the list that come before the specified cursor.
first · Int · Returns the first _n_ elements from the list.
last · Int · Returns the last _n_ elements from the list.

Returns

UserConnection!

Example 

query users(
  $active_status: String
  $conversation_id: ID
  $convo_patients_only: Boolean
  $email: String
  $expect_conversation_id: Boolean
  $from_superadmin: Boolean
  $group_id: String
  $has_cc_on_file: Boolean
  $id: ID
  $ids: [ID]
  $keywords: String
  $limited_to_provider: Boolean
  $provider_id: String
  $show_all_by_default: Boolean
  $sort_by: String
  $order_by: UserOrderKeys
  $tag_ids: [ID]
  $with_feature_toggles: Boolean
  $include_suborg_patients: Boolean
  $after: String
  $before: String
  $first: Int
  $last: Int
) {
  users(
    active_status: $active_status
    conversation_id: $conversation_id
    convo_patients_only: $convo_patients_only
    email: $email
    expect_conversation_id: $expect_conversation_id
    from_superadmin: $from_superadmin
    group_id: $group_id
    has_cc_on_file: $has_cc_on_file
    id: $id
    ids: $ids
    keywords: $keywords
    limited_to_provider: $limited_to_provider
    provider_id: $provider_id
    show_all_by_default: $show_all_by_default
    sort_by: $sort_by
    order_by: $order_by
    tag_ids: $tag_ids
    with_feature_toggles: $with_feature_toggles
    include_suborg_patients: $include_suborg_patients
    after: $after
    before: $before
    first: $first
    last: $last
  )
}