Skip to content

appointmentsCount

Number of Appointments

Arguments

exclude_appointments_with_invoice · Boolean · when true, all appointments with invoices will be excluded
filter · String · Options are 'future', 'past', 'ended', 'didnt-occur'
filter_by_appointment_location_ids · [ID] · Returns appointments of the specified appointment locations. Overrides filter_by_location_id
filter_by_appointment_statuses · [String] · Returns appointments of the specified appointment statuses. Overrides filter_by_appointment_status
filter_by_appointment_type_ids · [ID] · Returns appointments of the specified appointment types. Overrides filter_by_appointment_type_id
filter_by_chart_note_written · Boolean · When true, only appointments without an associated chart note will be returned. When false, only appointments with an associated chart note will be return. If nil, has no effect
filter_synced_appointments · Boolean · When true, no pulled-in synced appointments will be included
filter_by_invoices · Boolean · When true, only appointments up to the next future scheduled appointment will be included
use_provider_inclusions · Boolean · When true, use provider inclusions for lookup of providers
include_nil_blockers · Boolean · When true, returns blocking appointments with no appointment type/location/status
include_suborganizations · Boolean · include all providers in the organization and sub-organizations
is_org · Boolean · When true, returns appointments for all providers in the org
sort_by · String · Allowed options are date_desc, date_asc, created_at_desc, created_at_asc, updated_at_desc, and updated_at_asc
attendee_ids · [ID] · Returns appointments for the specified attendee_ids
only_healthie_appointments · Boolean · When true, returns only healthie appointments and excluding external appointments

Returns

Int

Example

query appointmentsCount(
$colorSchemeId: String
$currentWeek: Boolean
$endDate: String
$exclude_appointments_with_invoice: Boolean
$filter: String
$filter_by_appointment_location_ids: [ID]
$filter_by_appointment_status: String
$filter_by_appointment_statuses: [String]
$filter_by_appointment_type_id: ID
$filter_by_appointment_type_ids: [ID]
$filter_by_contact_types: String
$filter_by_chart_note_written: Boolean
$filter_by_client_confirmed: Boolean
$filter_by_location_id: ID
$filter_by_provider_confirmed: Boolean
$filter_synced_appointments: Boolean
$filter_by_invoices: Boolean
$use_provider_inclusions: Boolean
$include_blockers: Boolean
$include_nil_blockers: Boolean
$include_suborganizations: Boolean
$is_active: Boolean
$is_confirmed: Boolean
$is_org: Boolean
$is_upcoming: Boolean
$is_with_clients: Boolean
$keywords: String
$provider_id: ID
$provider_ids: [ID]
$show_appointments: Boolean
$sort_by: String
$order_by: AppointmentOrderKeys
$specificDay: String
$startDate: String
$unconfirmed: Boolean
$user_id: ID
$with_all_statuses: Boolean
$with_others: Boolean
$without_status: Boolean
$attendee_ids: [ID]
$state_license: String
$tag_ids: [ID]
$only_healthie_appointments: Boolean
$should_paginate: Boolean
) {
appointmentsCount(
colorSchemeId: $colorSchemeId
currentWeek: $currentWeek
endDate: $endDate
exclude_appointments_with_invoice: $exclude_appointments_with_invoice
filter: $filter
filter_by_appointment_location_ids: $filter_by_appointment_location_ids
filter_by_appointment_status: $filter_by_appointment_status
filter_by_appointment_statuses: $filter_by_appointment_statuses
filter_by_appointment_type_id: $filter_by_appointment_type_id
filter_by_appointment_type_ids: $filter_by_appointment_type_ids
filter_by_contact_types: $filter_by_contact_types
filter_by_chart_note_written: $filter_by_chart_note_written
filter_by_client_confirmed: $filter_by_client_confirmed
filter_by_location_id: $filter_by_location_id
filter_by_provider_confirmed: $filter_by_provider_confirmed
filter_synced_appointments: $filter_synced_appointments
filter_by_invoices: $filter_by_invoices
use_provider_inclusions: $use_provider_inclusions
include_blockers: $include_blockers
include_nil_blockers: $include_nil_blockers
include_suborganizations: $include_suborganizations
is_active: $is_active
is_confirmed: $is_confirmed
is_org: $is_org
is_upcoming: $is_upcoming
is_with_clients: $is_with_clients
keywords: $keywords
provider_id: $provider_id
provider_ids: $provider_ids
show_appointments: $show_appointments
sort_by: $sort_by
order_by: $order_by
specificDay: $specificDay
startDate: $startDate
unconfirmed: $unconfirmed
user_id: $user_id
with_all_statuses: $with_all_statuses
with_others: $with_others
without_status: $without_status
attendee_ids: $attendee_ids
state_license: $state_license
tag_ids: $tag_ids
only_healthie_appointments: $only_healthie_appointments
should_paginate: $should_paginate
)
}