Vetspire API

Guides

Introduction GraphQL Guide

Queries

Notifications alertNotifications notifications unreadNotificationsCount

Hospital

Tasks overdueTasksCount task taskCategories tasks

Telemedicine videoRoomToken

Triggers trigger triggers

Rdvms contacts getRdvmRecentPatients rdvm rdvmContact rdvmDocument rdvms rdvmsCount searchRdvms visits visitsCount

Board activeBoardRows boardCell boardGroups boardRow

Inventory clientConsent diagnostic fulfillmentSource fulfillmentSources inventoryAdjustment inventoryAdjustments productCategories productCategory productHistory productManufacturers productType productTypes

VoiceCall activeVoiceCalls callLog callLogs callLogsCount dialpadOffices recentVoiceCalls recentVoiceCallsCount

NewBilling coupon coupons estimate estimateItems orderFlag orderFlags payment productPackage productPackages reconciliationNotes revenueCenter revenueCenterBudgets revenueCenters voidablePaymentMethods

Lab getInhouseDevices labOrder labOrders labResult labResults labTests modalities orgLab orgLabOrders orgLabResults orgLabs orphanedLabs storedLabTests

Conversations conversation conversations conversationsPaginated openConversationsCount unreadConversations unreadConversationsCount

Marketing cadence cadences newsletter newsletters previewCadence protocol protocolReminders protocolRemindersCount protocols

Clinical allergies complication complications customPatientFieldValues diagnostics encounter encounterProducts encounterSummary encounterTypes encounters encountersUpdatedSince immunization immunizationPdf immunizations immunizationsDue lapsingPatients macro macros mandatoryConsentForms medicalRecordsSummary medication medications patient patientComplication patientConsentForms patientDocument patientLabel patientProtocols patientQrCode patientTag patientTags patients problems rabiesCertificate rabiesCertificates searchDiagnoses searchEmailAttachments searchMacros totalPatients treatments vitals vitalsTemplate

Treatment treatmentSheet treatmentSheetTemplate treatmentSheetTemplates treatmentSheets treatmentSummary

Analytics analytics count usageReport

Plan patientPlan patientPlans patientPlansCount plan preventionPlan preventionPlans

Billing bills ccTerminals creditMemos creditMemosTotals estimatePdf estimates estimatesTotals hasBalanceDue inCollections invoicePdf ledgerEntries ledgerEntryTotals masterProducts order orderItems orderItemsTotals orders ordersTotals packs payments paymentsTotals processorPayments product products productsCount productsInStockCount purchaseOrder purchaseOrders refundedOrderItems returnedOrderItems searchCoupons searchInventoryBuckets searchPackages searchProductCategories searchProductTypes searchProductables searchProducts searchVendors stripeConnectionToken stripePublishableKey vendor vendors

Events events

Reminders reminders sentReminders

Accounts addresses apiKeys checkDuplicatePhoneNumber client clientTag clientTags clients clientsCount coowners countNewClients externalCommPreferences externalSearch phoneNumbers provider providerAuthToken providerRole providerRoles providers searchAccounts totalClients viewer viewerSubscription

Boarding availableCages boardingCages boardingWards bookedDays reservation reservationKennelPdf reservationTypes reservations

Entities alert alerts clientReferralSource clientReferralSources clientTag consentForm consentForms customClientFields customPatientFields departments emailAttachmentIntegration emailAttachmentIntegrations encounterType entityValidations fileFolders files isDaycareOpen location locationChatMessages locationTag locationTags locations locationsDepartments org providerDepartments searchLocationTags searchPrintnodeComputers searchPrintnodePrinters

Schedule appointment appointmentReminders appointmentTypeTag appointmentTypeTags appointmentTypes appointments availableTimes countAppointmentProviders countAppointments countViewerAppointments locationAppointmentTypes locationSchedules scheduleTemplate scheduleTemplates selfCheckInLink

Mutations

Tasks assignProviderToTask createTask createTaskCategory createUserTask deleteTaskCategory unassignProviderFromTask updateTask updateTaskCategory

Conversations createConversation deleteMessage sendMessage startConversation updateConversation upsertMessage

Schedule createAppointment createAppointmentReminder createAppointmentType createAppointmentTypeTag createLocationProviderSchedule createLocationSchedule createScheduleTemplate deleteAppointment deleteAppointmentReminder deleteAppointmentType deleteAppointmentTypeTag deleteLocationProviderSchedule deleteLocationSchedule deleteScheduleTemplate makeAppointmentTypeDefault sendApptConfirmation setApptPickupTime textApptReady updateAppointment updateAppointmentIntake updateAppointmentType updateAppointmentTypeTag updateLocationHours updateLocationProviderSchedule updateLocationSchedule updateScheduleTemplate

Entities acquireFaxNumber acquireTollFreeNumber acquireTwilioPhoneNumber assignProviderToLocation createAlert createCage createClientRdvm createClientReferralSource createConsentForm createCustomClientField createCustomLocationAttribute createCustomPatientField createDepartment createEmailAttachmentIntegration createEntityValidation createLocation createLocationAttribute createLocationTag createOrgPreference deleteAlert deleteCage deleteClientRdvm deleteClientReferralSource deleteConsentForm deleteCustomClientField deleteCustomLocationAttribute deleteCustomPatientField deleteDepartment deleteEmailAttachmentIntegration deleteEncounterType deleteEntityValidation deleteLocation deleteLocationTag fileDownloadLink loginGoogleCloudPrint mergeClientReferralSources removeGoogleCloudPrintCredentials reorderClientReferralSources sendLocationChatMessage setChatLastReadAt setDaycareOpen unassignProviderFromLocation updateAlert updateCage updateClientRdvm updateClientReferralSource updateConsentForm updateCustomLocationAttribute updateDepartment updateEmailAttachmentIntegration updateEntityValidation updateLocation updateLocationAttribute updateLocationTag updateOrg updateOrgPreference uploadClinicImage uploadLocationLogo uploadOrgLogo

Clinical addLinkedClinicalNote addLinkedEncounter addTreatment assignProblemToEncounter attachGmailAttachmentToEncounter cancelVetsourceOrder captureClientConsent clientConsentLink copyFromPreviousEncounter copyMedicationsToEncounter createAllergy createApptVitals createComplication createCustomPatientFieldValue createCustomPatientProtocol createEncounterOrder createEncounterSection createEncounterSectionDatum createEncounterType createImmunization createMacro createParentProblem createPatient createPatientComplication createPatientTag createProblem createVitals deleteAllergy deleteClientConsent deleteComplication deleteEncounter deleteEncounterSection deleteEncounterSectionDatum deleteLinkedClinicalNote deleteLinkedEncounter deleteMacro deleteMedication deletePatientComplication deletePatientDocument deletePatientTag deleteProblem deleteVitals emailEncounter emailEncounterPdf emailEncounterRecord emailEncounterRecordToCustom emailEncounterRecordToRdvms emailHospitalizationNoticeToRdvms emailImmunizationsRecord emailMedicalRecordsSummary emailRabiesCertificate emailSelectedRabiesCertificates encounterPdf genVetsourceUrl markAllNormalEncounter massMicrochipRegister mergePatients movePatientToClient newEncounter orderVetsource prescribeMedication printLabelPrintnode pushMedicationToCubex pushToCubex pushTreatmentToCubex recordPatientWeight refillMedication regeneratePatientProtocols registerPatientMicrochip reopenEncounter replaceEncounterSectionDatum saveMicrochip sendEstimateConsentDepositLink sendSurveyLink signEncounter surgeryLogPdf transferPatient triggerPrescription unassignProblemFromEncounter updateAllergy updateComplication updateCustomPatientFieldValue updateCustomPatientProtocol updateEncounter updateEncounterSection updateEncounterSectionDatum updateEncounterType updateImmunization updateLinkedClinicalNote updateLinkedEncounter updateMacro updateMedication updatePatient updatePatientComplication updatePatientDocument updatePatientTag updateProblem updateVitals uploadEncounterTypeAsset uploadPatientDocument uploadPatientImage valuesetLabel

Payroll clockIn clockOut createProviderPunch deleteProviderPunch updateProviderPunch

Reminders createReminder createReminderSilence deleteReminder updateReminder updateReminderSilence

Inventory createDiagnostic createFulfillmentSource createInventoryAdjustment createProductCategory createProductType deleteDiagnostic deleteFulfillmentSource deletePendingInvoiceItem deleteProductCategory deleteProductType generateInventoryReport generateUsageSummaryReport reassignProductType updateDiagnostic updateFulfillmentSource updatePendingInvoiceItem updateProductCategory updateProductEnabled updateProductType uploadMassInventory

VoiceCall convertCallLogToAppointment createCallLog createVoiceCallLog deleteCallLog dismissVoiceCalls linkCall unlinkCall updateCallLog updateDialpadSubscription updateVoiceCall

Lab addReviewerToLabResult cancelLabOrder createOrgLab deleteLabOrder deleteLabResult deleteOrgLab emailLabResult finishLabOrder onboardPetdxLab orderLab refreshLabResult removeReviewerFromLabResult retryLabOrderPlacement testLabCredentials updateLabOrder updateLabResult updateOrgLab

Plan cancelPlan createPreventionPlan enrollPlan refreshPreventionPlan updatePatientPlan updatePreventionPlan

Billing addCreditMemo addLinkedProduct addOrderItem addOrderItemToEncounter addPackageToEncounter addPackageToEstimate addPackageToOrder addPurchaseOrderItem addToWishlist applyAccountCredit billingHistory billingStatement convertEstimateToOrder createOrder createProduct createPurchaseOrder createStripePaymentIntent creditMemoPdf deleteLinkedProduct deleteOrder deleteProduct deletePurchaseOrder deletePurchaseOrderItem deleteWishlistItem emailClientBillingStatement emailClientPaymentReceipt emailCreditMemoToClient emailEstimateToClient emailInventoryCsv emailInvoiceToClient emailProductsCsv endOfDayReport generateInvoice groupOrderItemsByPatient invoiceBarcodesPdf invoicePendingItems issueCreditDiscount markOrderUncollectible newVendor orderWishlist paymentReceiptPdf refundOrderItem reopenOrder reorderEstimateItems reorderOrderItems returnOrderItem saveEstimate sendPaymentRequest updateOrder updateOrderItem updateProductProductCategory updatePurchaseOrder updatePurchaseOrderItem updateVendor updateWishlistItem uploadMassProducts upsertLowStockThreshold upsertPackageLocationMarkup upsertProductLocationMarkup upsertProductTypeLocationMarkup

Marketing createCadence createNewsletter createProtocol deleteCadence deleteProtocol markPostcardProtocolReminderAsSent resendAllFailedProtocolReminders sendNewsletter sendNewsletterTest updateCadence updateNewsletter updateProtocol updateProtocolReminder

Boarding checkInReservation checkOutReservation createBoardingBlock createBoardingCage createBoardingWard createReservation createReservationEstimate deleteBoardingBlock deleteBoardingCage deleteBoardingWard deleteReservation reorderBoardingCages reorderBoardingWards updateBoardingBlock updateBoardingCage updateBoardingWard updateReservation

NewBilling addEstimateItem addPackageToPackage applyCoupon applyEstimateCoupon autoApplyCoupons autoApplyEstimateCoupons chargeClient chargeEstimate chargeOrder copyPackage createBillingNote createCoupon createEstimate createEstimateItem createOrderFlag createProductPackage createProductPackageItem createProductPrice createReconciliationNote createRevenueCenter createRevenueCenterBudget declinePackage deleteAppliedCoupon deleteAppliedEstimateCoupon deleteCoupon deleteEstimate deleteEstimateItem deleteOrderFlag deleteOrderItem deletePackagePackage deleteProductPackage deleteProductPackageItem deleteProductPrice deleteRevenueCenter refundPayment updateCoupon updateEstimate updateEstimateItem updateEstimateItems updateOrderFlag updateOrderItems updatePayment updateProduct updateProductPackage updateProductPackageItem updateProductPrice updateReconciliationNote updateRevenueCenter updateRevenueCenterBudget voidPayment

Telemedicine endVideoCall

License createLicense deleteLicense updateLicense

Rdvms createRdvm createRdvmContact createRdvmVisit deleteRdvm deleteRdvmDocument deleteRdvmVisit emailRdvmsCsv mergeRdvms updateRdvm updateRdvmContact updateRdvmVisit uploadMassRdvms uploadRdvmDocument

Comments comment updateComment

Board addPatientToBoard completeBoardCell createBoardCell deleteBoardCell invoiceBoardRow promoteEstimateToBoard uncompleteBoardCell updateBoardCell updateBoardRow

Analytics downloadUsageReport emailUsageReport

Triggers createTrigger deleteTrigger updateTrigger

Notifications deleteNotification readAllNotifications readNotification

Hospital createClinicalNote createHospitalization updateClinicalNote updateHospitalization

Treatment addTreatmentSheetCellComment addTreatmentSheetRow createTreatmentSheet createTreatmentSheetCell createTreatmentSheetTemplate deleteTreatmentSheet deleteTreatmentSheetRow deleteTreatmentSheetRowAdditiveEntry deleteTreatmentSheetTemplate saveTreatmentSheetCellOrderItem saveTreatmentSheetRowAdditiveEntry signTreatmentSheet updateTreatmentSheet updateTreatmentSheetCell updateTreatmentSheetRow updateTreatmentSheetStart updateTreatmentSheetTemplate updateTreatmentSheetTimeSlots

Accounts addClientAddress addClientStripeInfo addCoowner createApiKey createBridgeUser createClient createClientTag createCustomClientFieldValue createProvider createProviderRole deleteAddress deleteApiKey deleteClientTag deleteCoowner deleteProviderRole emailClientsAddresses generateClientAuthToken mergeClients removeClientStripeInfo resendVerification saveProviderElectronicSignature sendClientCheckinLink sendEmailVerification syncClient updateAddress updateClient updateClientExternalCommPreferences updateClientTag updateCoowner updateCustomClientFieldValue updatePhoneNumber updateProvider updateProviderRole updateViewer updateViewerPassword uploadProviderElectronicSignature uploadProviderProfileImage upsertProviderAppointmentTypeLimit upsertProviderCommission upsertProviderPreferences

Objects

Address Alert AlertNotification Allergy AnalyticsData AnalyticsDataRow AnalyticsDataRowBreakdown ApiKey Appointment AppointmentIntakeData AppointmentReminder AppointmentType AppointmentTypeTag ApptCountProviders Attachment AutoMessage AvailableTimeSlot BillingNote BoardCell BoardGroup BoardRow BoardingCage BoardingWard Cadence Cage CallLog CheckboxDatum ChecklistDatum Client ClientConsent ClientExternalCommPreferencesValue ClientRdvm ClientReferralSource ClientResult ClientTag ClinicalNote Comment Complication Conditional ConsentForm Conversation ConversationPage Coowner Coupon CreditMemo CreditMemoTotals Cursor CustomClientField CustomClientFieldValue CustomLocationAttribute CustomPatientField CustomPatientFieldValue CustomPatientProtocol CustomVital DatasyncLog DatasyncRecords DateCount Department DeprecatedVitalDatum Diagnosis Diagnostic DialpadOffice DropdownDatum ElectronicSignature EmailAttachment EmailAttachmentIntegration EmailStatus EmailTemplate Encounter EncounterProduct EncounterSection EncounterType EncounterVersion EntitiesTag EntityTag EntityTagGroup EntityValidation Estimate EstimateItem EstimatesTotals Event ExternalSearchResult ExtraField FeatureFlag FieldDatum FieldDatumPart File FileResults FormDatum FormulaDatum FulfillmentSource Highlight Hospitalization ImageDatum Immunization ImmunizationDatum InventoryAdjustment InventoryBucket InventoryLevel InventoryLog LabDevice LabOrder LabResult LabTest LedgerEntry LedgerEntryTotals License LinkedClinicalNote LinkedEncounter Location LocationAttribute LocationChatMessage LocationHours LocationKpi LocationProviderSchedule LocationSchedule LocationTag LowStockThreshold Macro MassUploadResult MasterProduct Medication Message Modality MonitorDatum RootMutationType Newsletter NoteDatum Notification NotificationMetadata ObanJob OldDatum Order OrderFlag OrderItem OrderItemsTotals OrdersTotals Org OrgLab OrgPreference OrgSubscription Pack Patient PatientComplication PatientDocument PatientPlan PatientPlanItem PatientProtocol PatientSubscription PatientTag Payment PaymentSource PaymentsTotals PendingImmunizationDatum PendingInvoiceItem PendingPackageDatum PendingRxDatum PhoneNumber PlanOption PreventionPlan PriceChange PriceChangeFilter PriceTier PrintLabelResult PrintnodeComputersField PrintnodePrintersField Problem ProcessorPayment Product ProductCategory ProductManufacturer ProductMetadataField ProductPackage ProductPackageItem ProductPrice ProductType Protocol ProtocolReminder Provider ProviderAppointmentTypeLimit ProviderCommission ProviderPreferences ProviderPunch ProviderRole PurchaseOrder PurchaseOrderItem RootQueryType Rdvm RdvmContact RdvmDocument RdvmRecentPatients RdvmVisit ReconciliationNote Reminder ReminderSilence RepeatingEvent Reservation ReservationNightlyPrice ReservationType ReturnedOrderItem RevenueCenter RevenueCenterBudget RowUploadError RxDatum ScheduleTemplate ScheduleTemplateRange SentAutoMessage SentReminder SketchDatum StripePaymentIntent StripeReader RootSubscriptionType SyncClientResult Task TaskCategory TeletailsSession TestResult TextDatum Treatment TreatmentDatum TreatmentSheet TreatmentSheetCell TreatmentSheetCellComment TreatmentSheetRow TreatmentSheetRowAdditive TreatmentSheetRowAdditiveEntry TreatmentSheetRowBolus TreatmentSheetRowFluid TreatmentSheetTemplate TreatmentTimeInterval Trigger TriggerAddOrderItemOptions TriggerCreateTaskOptions TriggerDefaultOptions TriggerSendEmailOptions TriggerWebhookOptions UsageReport UsageReportTotals ValuesetDatum ValuesetDatumOption Vendor Viewer VitalDatum Vitals VitalsTemplate VoiceCall Weight WishlistItem

Unions

Bill LocationOrLocationTag MessageSender Orderable

Input Objects

Enums

AddressUse AnalyticsBreakdown AnalyticsDataRowModifier AnalyticsField AnalyticsSegment AppointmentStatus CadenceContactMethods CommentableEntityType Comparison ConditionalOperator ContactType ConversationMedium DiscountType DoubleBookingConstraint EncounterPdfType EncounterTypeEnum EstimateStatus EstimateType Eye FeatureFlagEnum FilterField ImmunizationStatus ImmunizationType InferredResultTypes InvoiceSortFieldEnum InvoiceStatus IsoCountry LabelSize LicenseType MedicationStatus ObanJobState OrderByEnum OrgLabType PaymentMethod PaymentSort PlanInterval PriceChangeFilterType PriceChangeStatus PriceChangeType PriceType PricingType ProblemType ProductApplicationType Pronouns PurchaseOrderStatus ReminderEvent ReminderType ReservationCategory ReservationStatus ReservationStatusFilter ReservationTime ReturnedOrderItemType RouteType Severity Sex SortFieldEnum SortOptions SortProductOptions TimeSegment TreatmentSheetFormat TreatmentSheetRowFluidType TreatmentSheetType TreatmentSheetUnits TriggerIf TriggerThen TriggeredProtocolsSortFieldEnum WeightUnit

Scalars

Boolean Date DateTime Decimal ID Int JSON NaiveDateTime Numrange Price String Truthy Upload

Tasks Mutations

Interactive examples coming soon...

assignProviderToTask :: Task

Assigns a provider to a task

Argument	Type	Description
providerId	ID!
taskId	ID!

createTask :: Task

Argument	Type	Description
input	TaskInput
patientId	ID!

createTaskCategory :: TaskCategory

No arguments.

createUserTask :: Task

Argument	Type	Description
input	TaskInput
locationId	ID
providerIds	[ID]
roleId	ID

deleteTaskCategory :: TaskCategory

Argument	Type	Description
id	ID!

unassignProviderFromTask :: Task

Removes a provider from a task

Argument	Type	Description
providerId	ID!
taskId	ID!

updateTask :: Task

Argument	Type	Description
id	ID!
input	TaskInput!

updateTaskCategory :: TaskCategory

Argument	Type	Description
id	ID!
input	TaskCategoryInput!