Vetspire API
Guides
IntroductionGraphQL Guide
Queries
Mutations
EntitiesacquireFaxNumberacquireTollFreeNumberacquireTwilioPhoneNumberassignProviderToLocationcreateAlertcreateCagecreateClientRdvmcreateClientReferralSourcecreateConsentFormcreateCustomClientFieldcreateCustomLocationAttributecreateCustomPatientFieldcreateDepartmentcreateEmailAttachmentIntegrationcreateEntityValidationcreateLocationcreateLocationAttributecreateLocationTagcreateOrgPreferencedeleteAlertdeleteCagedeleteClientRdvmdeleteClientReferralSourcedeleteConsentFormdeleteCustomClientFielddeleteCustomLocationAttributedeleteCustomPatientFielddeleteDepartmentdeleteEmailAttachmentIntegrationdeleteEncounterTypedeleteEntityValidationdeleteLocationdeleteLocationTagfileDownloadLinkloginGoogleCloudPrintmergeClientReferralSourcesremoveGoogleCloudPrintCredentialsreorderClientReferralSourcessendLocationChatMessagesetChatLastReadAtsetDaycareOpenunassignProviderFromLocationupdateAlertupdateCageupdateClientRdvmupdateClientReferralSourceupdateConsentFormupdateCustomLocationAttributeupdateDepartmentupdateEmailAttachmentIntegrationupdateEntityValidationupdateLocationupdateLocationAttributeupdateLocationTagupdateOrgupdateOrgPreferenceuploadClinicImageuploadLocationLogouploadOrgLogo
NewBillingaddEstimateItemaddPackageToPackageapplyCouponapplyEstimateCouponautoApplyCouponsautoApplyEstimateCouponschargeClientchargeEstimatechargeOrdercopyPackagecreateBillingNotecreateCouponcreateEstimatecreateEstimateItemcreateOrderFlagcreateProductPackagecreateProductPackageItemcreateProductPricecreateReconciliationNotecreateRevenueCentercreateRevenueCenterBudgetdeclinePackagedeleteAppliedCoupondeleteAppliedEstimateCoupondeleteCoupondeleteEstimatedeleteEstimateItemdeleteOrderFlagdeleteOrderItemdeletePackagePackagedeleteProductPackagedeleteProductPackageItemdeleteProductPricedeleteRevenueCentermarkOrderPaidIfFullyPaidrefundPaymentupdateCouponupdateEstimateupdateEstimateItemupdateEstimateItemsupdateOrderFlagupdateOrderItemsupdatePaymentupdateProductupdateProductPackageupdateProductPackageItemupdateProductPriceupdateReconciliationNoteupdateRevenueCenterupdateRevenueCenterBudgetvoidPayment
ClinicaladdLinkedClinicalNoteaddLinkedEncounteraddTreatmentassignProblemToEncounterattachGmailAttachmentToEncountercaptureClientConsentclientConsentLinkcopyFromPreviousEncountercopyMedicationsToEncountercreateAllergycreateApptVitalscreateCloudStorageUploadcreateComplicationcreateCustomPatientFieldValuecreateCustomPatientProtocolcreateEncounterOrdercreateEncounterProductcreateEncounterSectioncreateEncounterSectionDatumcreateEncounterTypecreateImmunizationcreateMacrocreateParentProblemcreatePatientcreatePatientComplicationcreatePatientTagcreateProblemcreateVitalsdeleteAllergydeleteClientConsentdeleteComplicationdeleteEncounterdeleteEncounterProductdeleteEncounterSectiondeleteEncounterSectionDatumdeleteImmunizationdeleteLinkedClinicalNotedeleteLinkedEncounterdeleteMacrodeleteMedicationdeletePatientComplicationdeletePatientDocumentdeletePatientTagdeleteProblemdeleteVitalsemailEncounteremailEncounterPdfemailEncounterRecordemailEncounterRecordToCustomemailEncounterRecordToRdvmsemailHospitalizationNoticeToRdvmsemailImmunizationsRecordemailMedicalRecordsSummaryemailRabiesCertificateemailSelectedRabiesCertificatesencounterPdfgenVetsourceUrlmarkAllNormalEncountermassMicrochipRegistermergePatientsmovePatientToClientnewEncounterprescribeMedicationprintLabelPrintnoderecordPatientWeightrefillMedicationregisterPatientMicrochipreopenEncounterreplaceEncounterSectionDatumsaveMicrochipsendEstimateConsentDepositLinksendSurveyLinksignEncountersurgeryLogPdftransferPatienttriggerPrescriptionunassignProblemFromEncounterupdateAllergyupdateComplicationupdateCustomPatientFieldValueupdateCustomPatientProtocolupdateEncounterupdateEncounterProductupdateEncounterSectionupdateEncounterSectionDatumupdateEncounterTypeupdateImmunizationupdateLinkedClinicalNoteupdateLinkedEncounterupdateMacroupdateMedicationupdatePatientupdatePatientComplicationupdatePatientDocumentupdatePatientTagupdateProblemupdateVitalsuploadEncounterTypeAssetuploadPatientDocumentuploadPatientImagevaluesetLabel
BillingaddCreditMemoaddLinkedProductaddOrderItemaddOrderItemToEncounteraddPackageToEncounteraddPackageToEstimateaddPackageToOrderaddPurchaseOrderItemaddToWishlistapplyAccountCreditbillingHistorybillingStatementconvertEstimateToOrdercreateOrdercreateProductcreateProductManufacturercreatePurchaseOrdercreateStripePaymentIntentcreditMemoPdfdeleteLinkedProductdeleteOrderdeleteProductdeleteProductManufacturerdeletePurchaseOrderdeletePurchaseOrderItemdeleteWishlistItememailBillingStatementsemailClientBillingStatementemailClientPaymentReceiptemailCreditMemoToClientemailEstimateToClientemailInventoryCsvemailInvoiceToClientemailProductsCsvendOfDayReportgenerateInvoicegroupOrderItemsByPatientinvoiceBarcodesPdfinvoicePendingItemsissueCreditDiscountmarkOrderUncollectiblenewVendororderWishlistpaymentReceiptPdfrefundOrderItemreopenOrderreorderEstimateItemsreorderOrderItemsreturnOrderItemsaveEstimatesendPaymentRequestupdateOrderupdateOrderItemupdateProductManufacturerupdateProductProductCategoryupdatePurchaseOrderupdatePurchaseOrderItemupdateVendorupdateWishlistItemuploadMassProductsupsertLowStockThresholdupsertPackageLocationMarkupupsertProductLocationMarkupupsertProductTypeLocationMarkup
NewBillingaddEstimateItemaddPackageToPackageapplyCouponapplyEstimateCouponautoApplyCouponsautoApplyEstimateCouponschargeClientchargeEstimatechargeOrdercopyPackagecreateBillingNotecreateCouponcreateEstimatecreateEstimateItemcreateOrderFlagcreateProductPackagecreateProductPackageItemcreateProductPricecreateReconciliationNotecreateRevenueCentercreateRevenueCenterBudgetdeclinePackagedeleteAppliedCoupondeleteAppliedEstimateCoupondeleteCoupondeleteEstimatedeleteEstimateItemdeleteOrderFlagdeleteOrderItemdeletePackagePackagedeleteProductPackagedeleteProductPackageItemdeleteProductPricedeleteRevenueCentermarkOrderPaidIfFullyPaidrefundPaymentupdateCouponupdateEstimateupdateEstimateItemupdateEstimateItemsupdateOrderFlagupdateOrderItemsupdatePaymentupdateProductupdateProductPackageupdateProductPackageItemupdateProductPriceupdateReconciliationNoteupdateRevenueCenterupdateRevenueCenterBudgetvoidPayment
Objects
AccountsReceivableBalanceAddressAlertAlertNotificationAllergyAnalyticsDataAnalyticsDataRowAnalyticsDataRowBreakdownApiKeyAppointmentAppointmentIntakeDataAppointmentReminderAppointmentTypeAppointmentTypeTagApptCountProvidersArReconciliationAttachmentAutoMessageAvailableTimeSlotBillingNoteBoardCellBoardGroupBoardRowBoardingCageBoardingWardCadenceCageCallLogCheckboxDatumChecklistDatumClientClientConsentClientExternalCommPreferencesValueClientRdvmClientReferralSourceClientResultClientTagClinicalNoteCloudStorageUploadCommentComplicationConditionalConsentFormConversationConversationPageCoownerCoownerBreakdownCouponCreditMemoCreditMemoTotalsCursorCustomClientFieldCustomClientFieldValueCustomLocationAttributeCustomPatientFieldCustomPatientFieldValueCustomPatientProtocolCustomVitalDatasyncLogDatasyncRecordsDateCountDeletionLogDepartmentDeprecatedVitalDatumDiagnosisDiagnosticDialpadOfficeDropdownDatumElectronicSignatureEmailAttachmentEmailAttachmentIntegrationEmailStatusEmailTemplateEncounterEncounterProductEncounterSectionEncounterTypeEncounterVersionEntitiesTagEntityTagEntityTagGroupEntityValidationEstimateEstimateItemEstimatesTotalsEventExternalSearchResultExtraFieldFeatureFlagFieldDatumFieldDatumPartFileFileResultsFormDatumFormulaDatumFulfillmentSourceHighlightHospitalizationHospitalizationTaskImageDatumImmunizationImmunizationDatumInventoryAdjustmentInventoryBucketInventoryLevelInventoryLogLabDeviceLabOrderLabResultLabResultImageLabTestLedgerEntryLedgerEntryTotalsLicenseLinkedClinicalNoteLinkedEncounterLocationLocationAttributeLocationChatMessageLocationHoursLocationKpiLocationProviderScheduleLocationScheduleLocationTagLowStockThresholdMacroMassUploadResultMasterProductMedicationMessageModalityMonitorDatumMonographMonographGuideMonographSectionRootMutationTypeNewsletterNoteDatumNotificationNotificationMetadataObanJobOrderOrderFlagOrderItemOrderItemsTotalsOrderPaymentMismatchOrdersTotalsOrgOrgLabOrgPreferencePackPatientPatientCompliancePatientComplicationPatientDocumentPatientPlanPatientPlanItemPatientProtocolPatientTagPaymentPaymentSourcePaymentsTotalsPendingImmunizationDatumPendingInvoiceItemPendingPackageDatumPendingRxDatumPhoneNumberPlanOptionPlumbsHandoutPreventionPlanPriceChangePriceChangeFilterPriceTierPrintLabelResultPrintnodeComputersFieldPrintnodePrintersFieldProblemProcessorPaymentProductProductCategoryProductManufacturerProductManufacturerPageProductMetadataFieldProductPackageProductPackageItemProductPriceProductTypeProtocolProtocolReminderProviderProviderAppointmentTypeLimitProviderCommissionProviderPreferencesProviderPunchProviderRolePurchaseOrderPurchaseOrderItemRootQueryTypeRdvmRdvmContactRdvmDocumentRdvmRecentPatientsRdvmVisitReconciliationNoteReminderReminderSilenceRepeatingEventReservationReturnedOrderItemRevenueCenterRevenueCenterBudgetRowUploadErrorRxDatumScheduleTemplateScheduleTemplateRangeSentAutoMessageSentReminderSketchDatumStripeAddressStripeBillingDetailsStripeCardStripeClientSecretStripeCustomerStripeInvoiceSettingsStripePaymentIntentStripePaymentMethodStripeReaderStripeUsBankAccountRootSubscriptionTypeSyncClientResultTaskTaskCategoryTeletailsSessionTestResultTextDatumTreatmentTreatmentDatumTreatmentSheetTreatmentSheetCellTreatmentSheetCellCommentTreatmentSheetRowTreatmentSheetRowAdditiveTreatmentSheetRowAdditiveEntryTreatmentSheetRowBolusTreatmentSheetRowFluidTreatmentSheetTemplateTreatmentTimeIntervalTriggerTriggerAddOrderItemOptionsTriggerCreateTaskOptionsTriggerDefaultOptionsTriggerProductTriggerSendEmailOptionsTriggerWebhookOptionsUsageReportUsageReportTotalsValuesetDatumValuesetDatumOptionVendorVetspireSubscriptionVetspireSubscriptionTierViewerVitalDatumVitalsVitalsTemplateVoiceCallWeightWishlistItem
Unions
BillLocationOrLocationTagMessageSenderOrderable
Input Objects
AddressInputAlertInputAllergyInputAnalyticsFieldModifierAppointmentInputAppointmentIntakeDataInputAppointmentReminderInputAppointmentTypeInputAppointmentTypeTagInputAutoMessageInputBillingNoteInputBoardCellInputBoardRowInputBoardingBlockInputBoardingCageInputBoardingWardInputCadenceInputCageInputCallLogInputClientExternalCommPreferencesInputClientFiltersClientInputClientRdvmInputClientReferralSourceInputClientTagInputClinicalNoteInputComplicationInputConditionalInputConsentFormInputConversationInputConversationSetAttachmentCoownerInputCouponInputCreditMemoInputCustomClientFieldInputCustomLocationAttributeInputCustomPatientFieldInputCustomPatientProtocolInputCustomVitalInputDepartmentInputDiagnosticInputEmailAttachmentIntegrationInputEmailTemplateInputEncounterInputEncounterProductInputEncounterSectionInputEncounterTypeInputEntitiesTagInputEntityTagGroupInputEntityTagInputEntityValidationInputEstimateInputEstimateItemInputEventMetadataFilterExternalSearchInputExtraFieldInputFilterFulfillmentSourceInputHospitalizationInputHospitalizationTaskInputImmunizationInputInventoryAdjustmentInputInventoryBucketInputLabOrderInputLabResultInputLicenseInputLinkedClinicalNoteInputLinkedEncounterInputLocationAttributeInputLocationFiltersLocationHoursInputLocationInputLocationProviderScheduleInputLocationScheduleInputLocationTagInputLowStockThresholdInputMacroInputMedicationInputNewsletterInputOrderFlagInputOrderInputOrderItemInputOrgInputOrgLabInputOrgPreferenceInputPatientComplicationInputPatientDocumentInputPatientFiltersPatientInputPatientPlanFiltersPatientPlanInputPatientPlanItemInputPatientRegistrationPatientTagInputPaymentInputPaymentSourceInputPendingInvoiceItemInputPhoneNumberInputPlanOptionInputPreventionPlanInputPriceChangeFilterInputPriceChangeInputPriceTierInputPrinterInputProblemInputProductCategoryInputProductInputProductManufacturerInputProductMetadataFieldInputProductPackageInputProductPackageItemInputProductPriceInputProductTypeFlagsProductTypeInputProtocolInputProtocolReminderInputProviderAppointmentTypeLimitInputProviderCommissionInputProviderInputProviderPreferencesInputProviderPunchInputProviderRoleInputProviderViewerInputPurchaseOrderInputPurchaseOrderItemInputRdvmContactInputRdvmInputRdvmVisitInputReconciliationNoteInputReminderInputReminderSilenceInputRepeatingEventInputReservationFiltersReservationInputRevenueCenterBudgetInputRevenueCenterInputSaveTreatmentSheetCellOrderItemInputScheduleTemplateInputScheduleTemplateRangeInputSyncClientInputTaskCategoryInputTaskInputTeletailsSessionInputTreatmentInputTreatmentSheetCellInputTreatmentSheetInputTreatmentSheetRowAdditiveEntryInputTreatmentSheetRowAdditiveInputTreatmentSheetRowBolusInputTreatmentSheetRowFluidInputTreatmentSheetRowInputTreatmentSheetTemplateInputTreatmentTemplateSectionTreatmentTimeIntervalInputTriggerInputVendorInputVitalsInputVitalsTemplateInputVoiceCallInputWishlistItemInput
Enums
AddressUseAnalyticsBreakdownAnalyticsDataRowModifierAnalyticsFieldAnalyticsSegmentAppointmentStatusCadenceContactMethodsCommentableEntityTypeComparisonConditionalOperatorContactTypeConversationMediumDiscountTypeDoubleBookingConstraintEncounterPdfTypeEncounterSummaryDocumentTypeEstimateStatusEstimateTypeEyeFeatureFlagEnumFilterFieldImmunizationStatusImmunizationTypeInferredResultTypesInvoiceSortFieldEnumInvoiceStatusIsoCountryLabelSizeLicenseTypeMedicationStatusObanJobStateOrderByEnumOrgLabTypePaymentMethodPaymentSortPlanIntervalPriceChangeFilterTypePriceChangeStatusPriceChangeTypePriceTypePricingTypeProblemTypeProductApplicationTypePronounsPurchaseOrderStatusReminderEventReminderTypeReservationCategoryReservationStatusReservationStatusFilterReservationTimeReturnedOrderItemTypeRouteTypeSeveritySexSortFieldEnumSortOptionsSortProductOptionsSubscriptionModelTimeSegmentTreatmentSheetFormatTreatmentSheetRowFluidTypeTreatmentSheetSummaryTypeTreatmentSheetTypeTreatmentSheetUnitsTriggerIfTriggerThenTriggeredProtocolsSortFieldEnumWeightUnit
Scalars
BooleanDateDateTimeDecimalIDIntJSONNaiveDateTimeNumrangePriceStringTruthyUpload

Object » Viewer

Fields

bridgeUserId (ID)

chatLastReadAt (DateTime)

commissions ([ProviderCommission])

dailySurgeryLimit (Int)

defaultLocationId (ID)

departments ([Location])

electronicSignature (ElectronicSignature)

email (String)

familyName (String)

freshchatRestoreId (String)

givenName (String)

hasPerm (Boolean)+

Does this viewer have a certain permission? Returns true if so, false if otherwise.

historicalId (String)

id (ID!)

insertedAt (NaiveDateTime)

isActive (Boolean)

isCallCenter (Boolean)

isGroomer (Boolean)

isOrgAdmin (Boolean)

isRelief (Boolean)

isSsoEnabled (Boolean)

isVeterinarian (Boolean)

lastLoginAt (NaiveDateTime)

licenseNumber (String)+

DEPRECATED: Please use the field licenses instead. 

licenses ([License])

locations ([Location])

missingVetLicense (Boolean)

name (String)

openPunches ([ProviderPunch])

org (Org)

orgId (ID)

payrollId (String)

position (Int)

preferences (ProviderPreferences)

profileImageUrl (String)

providerRole (ProviderRole)

providerRoleId (ID)

punches ([ProviderPunch])+

scheduleTemplate ([String])

shortBio (String)

suffix (String)

title (String)

updatedAt (NaiveDateTime)

username (String)

verified (Boolean)

vetsourcePin (String)