Vetspire API
Guides
IntroductionGraphQL Guide
Queries
Mutations
EntitiesacquireFaxNumberacquireTollFreeNumberacquireTwilioPhoneNumberassignProviderToLocationcreateAlertcreateCagecreateClientRdvmcreateClientReferralSourcecreateConsentFormcreateCustomClientFieldcreateCustomLocationAttributecreateCustomPatientFieldcreateDepartmentcreateEmailAttachmentIntegrationcreateEntityValidationcreateLocationcreateLocationAttributecreateLocationTagcreateOrgPreferencedeleteAlertdeleteCagedeleteClientRdvmdeleteClientReferralSourcedeleteConsentFormdeleteCustomClientFielddeleteCustomLocationAttributedeleteCustomPatientFielddeleteDepartmentdeleteEmailAttachmentIntegrationdeleteEncounterTypedeleteEntityValidationdeleteLocationdeleteLocationTagfileDownloadLinkloginGoogleCloudPrintmergeClientReferralSourcesremoveGoogleCloudPrintCredentialsreorderClientReferralSourcessendLocationChatMessagesetChatLastReadAtsetDaycareOpenunassignProviderFromLocationupdateAlertupdateCageupdateClientRdvmupdateClientReferralSourceupdateConsentFormupdateCustomLocationAttributeupdateDepartmentupdateEmailAttachmentIntegrationupdateEntityValidationupdateLocationupdateLocationAttributeupdateLocationTagupdateOrgupdateOrgPreferenceuploadClinicImageuploadLocationLogouploadOrgLogo
ClinicaladdLinkedClinicalNoteaddLinkedEncounteraddTreatmentassignProblemToEncounterattachGmailAttachmentToEncountercancelVetsourceOrdercaptureClientConsentclientConsentLinkcopyFromPreviousEncountercopyMedicationsToEncountercreateAllergycreateApptVitalscreateComplicationcreateCustomPatientFieldValuecreateCustomPatientProtocolcreateEncounterOrdercreateEncounterSectioncreateEncounterSectionDatumcreateEncounterTypecreateImmunizationcreateMacrocreateParentProblemcreatePatientcreatePatientComplicationcreatePatientTagcreateProblemcreateVitalsdeleteAllergydeleteClientConsentdeleteComplicationdeleteEncounterdeleteEncounterSectiondeleteEncounterSectionDatumdeleteLinkedClinicalNotedeleteLinkedEncounterdeleteMacrodeleteMedicationdeletePatientComplicationdeletePatientDocumentdeletePatientTagdeleteProblemdeleteVitalsemailEncounteremailEncounterPdfemailEncounterRecordemailEncounterRecordToCustomemailEncounterRecordToRdvmsemailHospitalizationNoticeToRdvmsemailImmunizationsRecordemailMedicalRecordsSummaryemailRabiesCertificateemailSelectedRabiesCertificatesencounterPdfgenVetsourceUrlmarkAllNormalEncountermassMicrochipRegistermergePatientsmovePatientToClientnewEncounterorderVetsourceprescribeMedicationprintLabelPrintnodepushMedicationToCubexpushToCubexpushTreatmentToCubexrecordPatientWeightrefillMedicationregeneratePatientProtocolsregisterPatientMicrochipreopenEncounterreplaceEncounterSectionDatumsaveMicrochipsendEstimateConsentDepositLinksendSurveyLinksignEncountersurgeryLogPdftransferPatienttriggerPrescriptionunassignProblemFromEncounterupdateAllergyupdateComplicationupdateCustomPatientFieldValueupdateCustomPatientProtocolupdateEncounterupdateEncounterSectionupdateEncounterSectionDatumupdateEncounterTypeupdateImmunizationupdateLinkedClinicalNoteupdateLinkedEncounterupdateMacroupdateMedicationupdatePatientupdatePatientComplicationupdatePatientDocumentupdatePatientTagupdateProblemupdateVitalsuploadEncounterTypeAssetuploadPatientDocumentuploadPatientImagevaluesetLabel
BillingaddCreditMemoaddLinkedProductaddOrderItemaddOrderItemToEncounteraddPackageToEncounteraddPackageToEstimateaddPackageToOrderaddPurchaseOrderItemaddToWishlistapplyAccountCreditbillingHistorybillingStatementconvertEstimateToOrdercreateOrdercreateProductcreatePurchaseOrdercreateStripePaymentIntentcreditMemoPdfdeleteLinkedProductdeleteOrderdeleteProductdeletePurchaseOrderdeletePurchaseOrderItemdeleteWishlistItememailClientBillingStatementemailClientPaymentReceiptemailCreditMemoToClientemailEstimateToClientemailInventoryCsvemailInvoiceToClientemailProductsCsvendOfDayReportgenerateInvoicegroupOrderItemsByPatientinvoiceBarcodesPdfinvoicePendingItemsissueCreditDiscountmarkOrderUncollectiblenewVendororderWishlistpaymentReceiptPdfrefundOrderItemreopenOrderreorderEstimateItemsreorderOrderItemsreturnOrderItemsaveEstimatesendPaymentRequestupdateOrderupdateOrderItemupdateProductProductCategoryupdatePurchaseOrderupdatePurchaseOrderItemupdateVendorupdateWishlistItemuploadMassProductsupsertLowStockThresholdupsertPackageLocationMarkupupsertProductLocationMarkupupsertProductTypeLocationMarkup
NewBillingaddEstimateItemaddPackageToPackageapplyCouponapplyEstimateCouponautoApplyCouponsautoApplyEstimateCouponschargeClientchargeEstimatechargeOrdercopyPackagecreateBillingNotecreateCouponcreateEstimatecreateEstimateItemcreateOrderFlagcreateProductPackagecreateProductPackageItemcreateProductPricecreateReconciliationNotecreateRevenueCentercreateRevenueCenterBudgetdeclinePackagedeleteAppliedCoupondeleteAppliedEstimateCoupondeleteCoupondeleteEstimatedeleteEstimateItemdeleteOrderFlagdeleteOrderItemdeletePackagePackagedeleteProductPackagedeleteProductPackageItemdeleteProductPricedeleteRevenueCenterrefundPaymentupdateCouponupdateEstimateupdateEstimateItemupdateEstimateItemsupdateOrderFlagupdateOrderItemsupdatePaymentupdateProductupdateProductPackageupdateProductPackageItemupdateProductPriceupdateReconciliationNoteupdateRevenueCenterupdateRevenueCenterBudgetvoidPayment
NewBillingaddEstimateItemaddPackageToPackageapplyCouponapplyEstimateCouponautoApplyCouponsautoApplyEstimateCouponschargeClientchargeEstimatechargeOrdercopyPackagecreateBillingNotecreateCouponcreateEstimatecreateEstimateItemcreateOrderFlagcreateProductPackagecreateProductPackageItemcreateProductPricecreateReconciliationNotecreateRevenueCentercreateRevenueCenterBudgetdeclinePackagedeleteAppliedCoupondeleteAppliedEstimateCoupondeleteCoupondeleteEstimatedeleteEstimateItemdeleteOrderFlagdeleteOrderItemdeletePackagePackagedeleteProductPackagedeleteProductPackageItemdeleteProductPricedeleteRevenueCenterrefundPaymentupdateCouponupdateEstimateupdateEstimateItemupdateEstimateItemsupdateOrderFlagupdateOrderItemsupdatePaymentupdateProductupdateProductPackageupdateProductPackageItemupdateProductPriceupdateReconciliationNoteupdateRevenueCenterupdateRevenueCenterBudgetvoidPayment
Objects
AddressAlertAlertNotificationAllergyAnalyticsDataAnalyticsDataRowAnalyticsDataRowBreakdownApiKeyAppointmentAppointmentIntakeDataAppointmentReminderAppointmentTypeAppointmentTypeTagApptCountProvidersAttachmentAutoMessageAvailableTimeSlotBillingNoteBoardCellBoardGroupBoardRowBoardingCageBoardingWardCadenceCageCallLogCheckboxDatumChecklistDatumClientClientConsentClientExternalCommPreferencesValueClientRdvmClientReferralSourceClientResultClientTagClinicalNoteCommentComplicationConditionalConsentFormConversationConversationPageCoownerCouponCreditMemoCreditMemoTotalsCursorCustomClientFieldCustomClientFieldValueCustomLocationAttributeCustomPatientFieldCustomPatientFieldValueCustomPatientProtocolCustomVitalDatasyncLogDatasyncRecordsDateCountDepartmentDeprecatedVitalDatumDiagnosisDiagnosticDialpadOfficeDropdownDatumElectronicSignatureEmailAttachmentEmailAttachmentIntegrationEmailStatusEmailTemplateEncounterEncounterProductEncounterSectionEncounterTypeEncounterVersionEntitiesTagEntityTagEntityTagGroupEntityValidationEstimateEstimateItemEstimatesTotalsEventExternalSearchResultExtraFieldFeatureFlagFieldDatumFieldDatumPartFileFileResultsFormDatumFormulaDatumFulfillmentSourceHighlightHospitalizationImageDatumImmunizationImmunizationDatumInventoryAdjustmentInventoryBucketInventoryLevelInventoryLogLabDeviceLabOrderLabResultLabTestLedgerEntryLedgerEntryTotalsLicenseLinkedClinicalNoteLinkedEncounterLocationLocationAttributeLocationChatMessageLocationHoursLocationKpiLocationProviderScheduleLocationScheduleLocationTagLowStockThresholdMacroMassUploadResultMasterProductMedicationMessageModalityMonitorDatumRootMutationTypeNewsletterNoteDatumNotificationNotificationMetadataObanJobOldDatumOrderOrderFlagOrderItemOrderItemsTotalsOrdersTotalsOrgOrgLabOrgPreferenceOrgSubscriptionPackPatientPatientComplicationPatientDocumentPatientPlanPatientPlanItemPatientProtocolPatientSubscriptionPatientTagPaymentPaymentSourcePaymentsTotalsPendingImmunizationDatumPendingInvoiceItemPendingPackageDatumPendingRxDatumPhoneNumberPlanOptionPreventionPlanPriceChangePriceChangeFilterPriceTierPrintLabelResultPrintnodeComputersFieldPrintnodePrintersFieldProblemProcessorPaymentProductProductCategoryProductManufacturerProductMetadataFieldProductPackageProductPackageItemProductPriceProductTypeProtocolProtocolReminderProviderProviderAppointmentTypeLimitProviderCommissionProviderPreferencesProviderPunchProviderRolePurchaseOrderPurchaseOrderItemRootQueryTypeRdvmRdvmContactRdvmDocumentRdvmRecentPatientsRdvmVisitReconciliationNoteReminderReminderSilenceRepeatingEventReservationReservationNightlyPriceReservationTypeReturnedOrderItemRevenueCenterRevenueCenterBudgetRowUploadErrorRxDatumScheduleTemplateScheduleTemplateRangeSentAutoMessageSentReminderSketchDatumStripePaymentIntentStripeReaderRootSubscriptionTypeSyncClientResultTaskTaskCategoryTeletailsSessionTestResultTextDatumTreatmentTreatmentDatumTreatmentSheetTreatmentSheetCellTreatmentSheetCellCommentTreatmentSheetRowTreatmentSheetRowAdditiveTreatmentSheetRowAdditiveEntryTreatmentSheetRowBolusTreatmentSheetRowFluidTreatmentSheetTemplateTreatmentTimeIntervalTriggerTriggerAddOrderItemOptionsTriggerCreateTaskOptionsTriggerDefaultOptionsTriggerSendEmailOptionsTriggerWebhookOptionsUsageReportUsageReportTotalsValuesetDatumValuesetDatumOptionVendorViewerVitalDatumVitalsVitalsTemplateVoiceCallWeightWishlistItem
Unions
BillLocationOrLocationTagMessageSenderOrderable
Input Objects
AddressInputAlertInputAllergyInputAnalyticsFieldModifierAppointmentInputAppointmentIntakeDataInputAppointmentReminderInputAppointmentTypeInputAppointmentTypeTagInputAutoMessageInputBillingNoteInputBoardCellInputBoardRowInputBoardingBlockInputBoardingCageInputBoardingWardInputCadenceInputCageInputCallLogInputClientExternalCommPreferencesInputClientFiltersClientInputClientRdvmInputClientReferralSourceInputClientTagInputClientsTagsInputClinicalNoteInputComplicationInputConditionalInputConsentFormInputConversationInputCoownerInputCouponInputCreditMemoInputCustomClientFieldInputCustomLocationAttributeInputCustomPatientFieldInputCustomPatientProtocolInputCustomVitalInputDepartmentInputDiagnosticInputEmailAttachmentIntegrationInputEmailTemplateInputEncounterInputEncounterProductInputEncounterSectionInputEncounterTypeInputEntitiesTagInputEntityTagGroupInputEntityTagInputEntityValidationInputEstimateInputEstimateItemInputEventMetadataFilterExternalSearchInputExtraFieldInputFilterFulfillmentSourceInputHospitalizationInputImmunizationInputInventoryAdjustmentInputInventoryBucketInputLabOrderInputLabResultInputLicenseInputLinkedClinicalNoteInputLinkedEncounterInputLocationAttributeInputLocationFiltersLocationHoursInputLocationInputLocationProviderScheduleInputLocationScheduleInputLocationTagInputLowStockThresholdInputMacroInputMedicationInputNewsletterInputOrderFlagInputOrderInputOrderItemInputOrgInputOrgLabInputOrgPreferenceInputPatientComplicationInputPatientDocumentInputPatientFiltersPatientInputPatientPlanFiltersPatientPlanInputPatientRegistrationPatientTagInputPaymentInputPaymentSourceInputPendingInvoiceItemInputPhoneNumberInputPlanOptionInputPreventionPlanInputPriceChangeFilterInputPriceChangeInputPriceTierInputPrinterInputProblemInputProductCategoryInputProductInputProductMetadataFieldInputProductPackageInputProductPackageItemInputProductPriceInputProductTypeFlagsProductTypeInputProtocolInputProtocolReminderInputProviderAppointmentTypeLimitInputProviderCommissionInputProviderInputProviderPreferencesInputProviderPunchInputProviderRoleInputProviderViewerInputPurchaseOrderInputPurchaseOrderItemInputRdvmContactInputRdvmInputRdvmVisitInputReconciliationNoteInputReminderInputReminderSilenceInputRepeatingEventInputReservationFiltersReservationInputRevenueCenterBudgetInputRevenueCenterInputSaveTreatmentSheetCellOrderItemInputScheduleTemplateInputScheduleTemplateRangeInputSyncClientInputTaskCategoryInputTaskInputTeletailsSessionInputTreatmentInputTreatmentSheetCellInputTreatmentSheetInputTreatmentSheetRowAdditiveEntryInputTreatmentSheetRowAdditiveInputTreatmentSheetRowBolusInputTreatmentSheetRowFluidInputTreatmentSheetRowInputTreatmentSheetTemplateInputTreatmentTemplateSectionTreatmentTimeIntervalInputTriggerInputVendorInputVitalsInputVitalsTemplateInputVoiceCallInputWishlistItemInput
Enums
AddressUseAnalyticsBreakdownAnalyticsDataRowModifierAnalyticsFieldAnalyticsSegmentAppointmentStatusCadenceContactMethodsCommentableEntityTypeComparisonConditionalOperatorContactTypeConversationMediumDiscountTypeDoubleBookingConstraintEncounterPdfTypeEncounterTypeEnumEstimateStatusEstimateTypeEyeFeatureFlagEnumFilterFieldImmunizationStatusImmunizationTypeInferredResultTypesInvoiceSortFieldEnumInvoiceStatusIsoCountryLabelSizeLicenseTypeMedicationStatusObanJobStateOrderByEnumOrgLabTypePaymentMethodPaymentSortPlanIntervalPriceChangeFilterTypePriceChangeStatusPriceChangeTypePriceTypePricingTypeProblemTypeProductApplicationTypePronounsPurchaseOrderStatusReminderEventReminderTypeReservationCategoryReservationStatusReservationStatusFilterReservationTimeReturnedOrderItemTypeRouteTypeSeveritySexSortFieldEnumSortOptionsSortProductOptionsTimeSegmentTreatmentSheetFormatTreatmentSheetRowFluidTypeTreatmentSheetTypeTreatmentSheetUnitsTriggerIfTriggerThenTriggeredProtocolsSortFieldEnumWeightUnit
Scalars
BooleanDateDateTimeDecimalIDIntJSONNaiveDateTimeNumrangePriceStringTruthyUpload

Object » Appointment

An appointment

Fields

admittedAt (DateTime)

arrivalTimeAt (DateTime)

bookedOnline (Boolean)

cage (Cage)

checkInLink (String)

checkedInAt (DateTime)

checkedOutAt (DateTime)

checkingOutAt (DateTime)

comments ([Comment!])

completedAt (DateTime)

confirmedAt (DateTime)

contagionRisk (Boolean)

creator (Provider)

deleted (Boolean)

deletedBy (Provider)

deletionReason (String)

department (Department)

departmentId (ID)

duration (Int)

Duration of the appointment (in minutes)

encounters ([Encounter])

historicalId (String)

id (ID)

insertedAt (NaiveDateTime)

intake ([AppointmentIntakeData])

isConfirmed (Boolean)

location (Location)

note (String)

npsScore (Int)

patient (Patient)

patientId (ID)

pickupTime (DateTime)

provider (Provider)

providerId (ID)

readyAt (DateTime)

reason (String)

Reason for the appointment

repeatingEvent (RepeatingEvent)

room (String)

schedule (LocationSchedule)

scheduleId (ID)

selfCheckInSent (Boolean)

selfCheckedIn (Boolean)

sentPickup (Boolean)

start (DateTime)

Date and time of the start of the appointment

startedAt (DateTime)

status (AppointmentStatus)

teleSessionCreated (Boolean)

type (AppointmentType)

updatedAt (NaiveDateTime)

vitals (Vitals)

waitedAt (DateTime)