Skip to content
Healthie API Docs

appointmentsCount

Number of Appointments

Arguments

colorSchemeId · String · Sets the color scheme ID for background color calculation.
currentWeek · Boolean · When true, returns appointments for the current week based on the user's timezone.
endDate · ISO8601DateTime · End of the date range, must be sent in with a start date.
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_status · String · Filters appointments by a single appointment status. Overridden by filter_by_appointment_statuses.
filter_by_appointment_statuses · [String] · Returns appointments of the specified appointment statuses. Overrides filter_by_appointment_status.
filter_by_appointment_type_id · ID · Filters appointments by a single appointment type. Overridden by filter_by_appointment_type_ids.
filter_by_appointment_type_ids · [ID] · Returns appointments of the specified appointment types. Overrides filter_by_appointment_type_id.
filter_by_contact_types · String · Comma-separated list of contact types to filter appointments by.
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 returned. If nil, has no effect.
filter_by_client_confirmed · Boolean · When true, returns only client-confirmed appointments. When false, returns only appointments not confirmed by the client.
filter_by_location_id · ID · Filters appointments by a single location. Overridden by filter_by_appointment_location_ids.
filter_by_provider_confirmed · Boolean · When true, returns only provider-confirmed appointments. When false, returns only appointments not confirmed by the provider.
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, uses provider inclusions for lookup of providers.
include_blockers · Boolean · When true, includes blocker appointments in the results.
include_nil_blockers · Boolean · When true, returns blocking appointments with no appointment type/location/status.
include_suborganizations · Boolean · When true, includes all providers in the organization and sub-organizations.
insurance_plan_ids · [ID] · Filters providers by insurance plans. Used in conjunction with is_org.
is_active · Boolean · When true, returns only active appointments.
is_confirmed · Boolean · When true, returns only confirmed appointments. When false, returns only unconfirmed appointments.
is_org · Boolean · When true, returns appointments for all providers in the org.
is_upcoming · Boolean · When true, returns only upcoming appointments.
is_with_clients · Boolean · When true, returns only appointments that include a client.
keywords · String · Keyword search term for filtering appointments.
provider_id · ID · Filters appointments for a specific provider.
provider_ids · [ID] · Filters appointments for multiple providers.
show_appointments · Boolean · When false, excludes regular appointments and only returns synced appointments.
sort_by · String · Allowed options are date_desc, date_asc, created_at_desc, created_at_asc, updated_at_desc, and updated_at_asc
order_by · AppointmentOrderKeys · Specifies the sort order for the returned appointments.
specificDay · String · Filters appointments to a specific day.
startDate · ISO8601DateTime · Start of the date range, must be sent in with an end date.
unconfirmed · Boolean · When true, returns only unconfirmed appointments.
organization_id · ID · The ID of the organization to pull appointments for. Defaults to current user organization if not set. Ignored if is_org is false.
user_id · ID · Filters appointments for a specific client.
with_all_statuses · Boolean · When true, includes appointments with all statuses, not just active ones.
with_others · Boolean · When true, excludes blocker appointments from the results.
without_status · Boolean · When true, returns only appointments without a status.
attendee_ids · [ID] · Returns appointments for the specified attendee IDs.
state_license · String · Filters providers by state license. Used in conjunction with is_org.
tag_ids · [ID] · Filters providers by tags. Used in conjunction with is_org.
only_healthie_appointments · Boolean · When true, returns only healthie appointments and excluding external appointments

Returns

Int

Example 

query appointmentsCount(
  $colorSchemeId: String
  $currentWeek: Boolean
  $endDate: ISO8601DateTime
  $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
  $insurance_plan_ids: [ID]
  $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: ISO8601DateTime
  $unconfirmed: Boolean
  $organization_id: ID
  $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
    insurance_plan_ids: $insurance_plan_ids
    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
    organization_id: $organization_id
    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
  )
}