appointments
Fetch paginated appointment collection
Arguments
exclude_appointments_with_invoice
· Boolean · when true, all appointments with invoices will be excluded 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 attendee_ids
· [ID] · Returns appointments for the specified attendee_ids Returns
[Appointment!] Example
query appointments( $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] $offset: Int $page_size: Int $should_paginate: Boolean $after: Cursor) { appointments( 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 offset: $offset page_size: $page_size should_paginate: $should_paginate after: $after ) { actual_duration add_to_gcal_link appointment_category appointment_inclusions_count appointment_label appointment_location_id appointment_type appointment_type_id assigned_groups attended_clients attendees attendees_on_waitlist backgroundColor can_be_rescheduled can_client_cancel can_client_reschedule client_confirmed client_updating confirmed connected_chart_note_locked connected_chart_note_string contact_type conversation_id created_at credit_was_used current_position_in_recurring_series cursor date default_color deleted_at end external_id_type external_videochat_url filled_embed_form form_answer_group form_answer_groups generated_token has_expanded_vbc_charting_fields has_in_progress_job id initiator_id insurance_billing_enabled is_blocker is_group is_zoom_chat last_client_conversation_id last_updated_by_id late_cancellation_fee length location locationResource max_attendees metadata minimum_advance_cancel_time minimum_advance_reschedule_time no_show_fee notes organization_id other_party_id patient_reschedule_count pm_status pm_status_changed_at pm_status_last_changed_by_id pricing_info provider provider_name providers reason recurring_appointment requested_payment resourceId room_id scheduled_by session_id should_create_cms1500_for_occurred_appointments start textColor time_recurring_override timezone_abbr title unauthenticated_ics_link updated_at use_zoom user user_id zoom_appointment zoom_cloud_recording_urls zoom_dial_in_info zoom_dial_in_info_html zoom_dial_in_numbers_json zoom_join_url zoom_meeting_id zoom_start_url }}