OBJECT
AppointmentType
An object containing information about the type of appointment
link GraphQL Schema definition
- type AppointmentType {
- # The number of clients with advance pricing for this appointment type
- String :
- # The number of providers with advance pricing for this appointment type
- String :
- # The appointment setting associated with this appointment type. An associated
- # appointment setting overrides the providers general one.
- AppointmentSetting :
- # The cpt code and units for this appointment type
- AppointmentTypeCptCodeType :
- # When true, the appointment pricing will be automatically increase based on
- # actual duration
- Boolean :
- # Is true if upcoming availability exists
- #
- # Arguments
- # appointment_location_id: The appointment location id
- # org_level: The org level
- # provider_id: The provider id
- # provider_ids: The list of provider ids
- (
- String, :
- Boolean, :
- String, :
- String] : [
- ): Boolean
- # List of available contact types for this appointment type
- String] : [
- # When true, this appointment type is bookable by user groups associated through
- # appointment_type_user_groups and appointment type is NOT bookable by ALL users
- Boolean :
- # user groups that can book this appointment type. Associated through
- # appointment_type_user_groups
- UserGroup!] : [
- # When true, this appointment type is bookable by users without a user group
- Boolean! :
- # Checks to see if the client call to provider
- Boolean :
- # The status of whether the client can self-book this type of appointment
- Boolean! :
- # Checks to see if the client has enough credit to book
- Boolean :
- # The date the Appointment Type was created
- String! :
- # Pagination cursor
- Cursor! :
- # If the provider's organization has this feature, this will customize the content
- # of SMS reminder's Healthie sends.
- String :
- # Date time appointment type was deleted
- String :
- # When true, the client will not be asked to add a reason when booking an
- # appointment of this type
- Boolean :
- # ID of the embedded custom module form
- String :
- # All form requests which should be created after appointment
- AppointmentTypeFormConnection!] : [
- # All form requests which should be created after appointment booking
- AppointmentTypeFormConnection!] : [
- # All form requests which should be created before appointment
- AppointmentTypeFormConnection!] : [
- # Is true if group appointment available
- #
- # Arguments
- # appointment_location_id: The appointment location id
- # provider_id: The provider id
- (
- String, :
- String :
- ): Boolean
- # When true, this appointment type has specific appointment settings that override
- # the general ones
- Boolean :
- # The unique identifier of the appointment type
- ID! :
- # The status of whether appointments of this types are group appointments or not
- Boolean! :
- # The status of whether waitlist is enabled for an appointment or not
- Boolean! :
- # The length of the appointment type (in minutes)
- Int :
- # the name of the appointment type
- String :
- # A custom message to display if there are no available slots on a given day for
- # an appointment type.
- String :
- # The position of the appointment type when shown in a list of other appointment
- # types
- Int :
- # The price and cpt_code_price
- PriceAndCptPriceType :
- # The pricing for this appointment type
- String :
- # Get the pricing info for this appointment type
- AppointmentPricingInfoType :
- # Pricing option for this appointment type
- String :
- # providers associated with appointment type
- ProviderApptTypeConnection!] : [
- # When this setting is turned on, provider state licensing requirements will be
- # enforced when clients try to schedule appointments.
- Boolean :
- # Whether or not appointment type should use specific providers
- Boolean! :
- # position of appointment type when displayed in packages list
- String :
- # A label that includes the length of the appointment
- String :
- # The date the Appointment Type was updated
- String! :
- # The user group associated with this appointment type.
- UserGroup :
- # The ID of the group clients are placed in after booking
- String :
- # The creator of the appointment type
- Int :
- # If provider state matches users or appointment type doesn't require state
- # license restrictions.
- #
- # Arguments
- # client_state_of_residence: The client state of residence
- # org_level: The org level
- # provider_id: The provider id
- # provider_ids: The list of provider ids
- (
- String, :
- Boolean, :
- String, :
- String] : [
- ): Boolean
- }
link Require by
- AppointmentAn appointment object containing information about the appointment, including the attendees, date, location, and more.
- AppointmentTypeCreditAn object containing information the clients' remaining credit for a given appointment type
- createAppointmentTypePayloadAutogenerated return type of createAppointmentType.
- CustomEmailRelatedObjectCustomEmail related_object union
- deleteAppointmentTypePayloadAutogenerated return type of deleteAppointmentType.
- OfferingIncludeOffering Include
- PotentialAppointmentSlotA potential appointment slot
- QueryThe query root of this schema. See available queries.
- SupportDashboardTypeSupport Dashboard Endpoints
- updateAppointmentTypePayloadAutogenerated return type of updateAppointmentType.
- UserAn user entry, returns basic user information