query { # Use this type in your queries someQuery { accountCreditHistory accountCreditsVoidedWithoutPaymentVoided accounts accountsReceivableBalance activeBoardRows }}accountCreditHistoryAccountCreditHistoryResponseLists account credits voided without corresponding payment voided
accountsClientConnectionactiveBoardRows[BoardRow]activeSubscriptionForOrgVetspireSubscriptionaddresses[Address]alertAlertallergies[Allergy]analytics[AnalyticsData]Lookup API keys for your org
appointmentAppointmentappointmentReminders[AppointmentReminder]appointmentsReportJSONRuns the appointments report and returns results inline. This report supports the following breakdowns: - LOCATION_ID - PROVIDER_ID - APPOINTMENT_TYPE_ID - IS_NEW_CLIENT - IS_NEW_OF_TYPE_CLIENT - IS_MEMBER - BOOKING_METHOD - BOOKING_PLACE - STATUS - APPOINTMENT_TYPE_REVENUE_CENTER_ID - CLIENT_ID - CLIENT_PHONE_NUMBER - PATIENT_ID - PATIENT_NAME - APPOINTMENT_TIME If results time out, please fetch smaller date ranges, otherwise please use the alternative `emailAppointmentsReport` query.
asyncMedicalRecordAsyncMedicalRecordavailableTimes[AvailableTimeSlot]Get NOVA billing frequency options for dropdown
billingGroupBillingGroupGet billing groups for dropdown (no permission required)
billingGroupsBillingGroupConnectionbillingGroupsCountIntbills[Bill]boardCellBoardCellboardGroups[BoardGroup]boardRowBoardRowbookedDays[Date!]cadenceCadencecadences[Cadence]cages[Cage]calculateBolusValuesBolusCalculationResultCalculates bolus values using patient weight. Provide either `amount` (ml/kg) OR `totalAmount` (ml): - If `amount` is provided: calculates totalAmount = amount × patientWeight - If `totalAmount` is provided: calculates amount = totalAmount ÷ patientWeight Always calculates: rate = totalAmount × 60 ÷ overPeriod
calculateDosageDosageCalculationResultcallLogCallLogcallLogsCountIntcallLogsReportJSONRuns the callLogs report and returns results inline. This report supports the following breakdowns: - LOCATION_ID - CAME_IN - CONSULTED_BY_DOCTOR_ID If results time out, please fetch smaller date ranges, otherwise please use the alternative `emailCalllogsReport` query.
callsReportJSONRuns the calls report and returns results inline. This report supports the following breakdowns: - LOCATION_ID If results time out, please fetch smaller date ranges, otherwise please use the alternative `emailCallsReport` query.
cardconnectVerifyCredentialsCardconnectVerifyCredentialsResultcareCreditAccessTokenStringcareTeamRoles[CareTeamRole]ccTerminals[String]censusCensuschangelogsChangelogConnectioncheckDuplicatePhoneNumberBooleanLists sum of client account credits by location
clientConsentClientConsentclientTagClientTagclientTags[ClientTag]clients[Client]Get a list of clients within your organization's database. Depending on how many providers your organization has, you may need to page through your data with filters.
clientsCountIntconsentFormConsentFormThe `should_convert_urls_to_a_tags` is a boolean flag that determines whether URLs should be converted into clickable links by adding an <a> tag with the CSS class `vespire-consent-form-link`.
consentForms[ConsentForm]conversationConversationconversations[Conversation]coowners[Coowner]count[AnalyticsDataRow]countAppointmentProviders[ApptCountProviders]Count the number of appointments in a range from start to end segmented into days, weeks, months, years.
countAppointments[DateCount]Count the number of appointments in a range from start to end segmented into days, weeks, months, years.
couponCouponcouponDiscountsReport[ReportRow]Runs the couponDiscounts report and returns results inline. This report supports the following breakdowns: - LOCATION_ID - REVENUE_CENTER_ID - PROVIDER_ID - PRODUCT_ID If results time out, please fetch smaller date ranges, otherwise please use the alternative `emailCoupondiscountsReport` query.
coupons[Coupon]creditMemos[CreditMemo]creditMemosTotalsCreditMemoTotalscreditReasons[CreditReason]customAppointmentFields[CustomAppointmentField]Get all custom appointment fields at the viewer's org
dailyStockTransferReport[DailyStockTransferReportItem]dashboardDashboarddeceasedPatientsCountIntdeceasedPatientsReportDeceasedPatientItemConnectiondeclineReasons[DeclineReason]departments[Department]detailedCreditsCountIntdetailedCreditsReportDetailedCreditItemConnectiondetailedSalesRevenueCountIntdetailedSalesRevenueReportDetailedSalesRevenueItemConnectiondetectStripePaymentTypeStripePaymentTypeResultdiagnosticDiagnosticdiagnostics[Diagnostic]dialpadOffices[DialpadOffice]discountReasons[DiscountReason]emailAppointmentsReportBooleanRuns the appointments report and emails the results as an excel file to the given email address. This report supports the following breakdowns: - LOCATION_ID - PROVIDER_ID - APPOINTMENT_TYPE_ID - IS_NEW_CLIENT - IS_NEW_OF_TYPE_CLIENT - IS_MEMBER - BOOKING_METHOD - BOOKING_PLACE - STATUS - APPOINTMENT_TYPE_REVENUE_CENTER_ID - CLIENT_ID - CLIENT_PHONE_NUMBER - PATIENT_ID - PATIENT_NAME - APPOINTMENT_TIME If results are requested inline, please use the provided `appointmentsReport` query.
emailCallLogsReportBooleanRuns the callLogs report and emails the results as an excel file to the given email address. This report supports the following breakdowns: - LOCATION_ID - CAME_IN - CONSULTED_BY_DOCTOR_ID If results are requested inline, please use the provided `callLogsReport` query.
emailCallsReportBooleanRuns the calls report and emails the results as an excel file to the given email address. This report supports the following breakdowns: - LOCATION_ID If results are requested inline, please use the provided `callsReport` query.
emailCouponDiscountsReportBooleanRuns the couponDiscounts report and emails the results as an excel file to the given email address. This report supports the following breakdowns: - LOCATION_ID - REVENUE_CENTER_ID - PROVIDER_ID - PRODUCT_ID If results are requested inline, please use the provided `couponDiscountsReport` query.
emailGrossSalesReportBooleanRuns the grossSales report and emails the results as an excel file to the given email address. This report supports the following breakdowns: - LOCATION_ID - REVENUE_CENTER_ID - PROVIDER_ID - PRODUCT_ID - PRODUCT_TYPE_ID - PRODUCT_CATEGORY_ID - CLIENT_ID If results are requested inline, please use the provided `grossSalesReport` query.
emailPaidSalesReportBooleanRuns the paidSales report and emails the results as an excel file to the given email address. This report supports the following breakdowns: - LOCATION_ID - REVENUE_CENTER_ID - PROVIDER_ID - PRODUCT_ID - PRODUCT_TYPE_ID - PRODUCT_CATEGORY_ID - CLIENT_ID - PAYROLL_ID If results are requested inline, please use the provided `paidSalesReport` query.
emailProtocolRemindersReportBooleanRuns the protocolReminders report and emails the results as an excel file to the given email address. This report supports the following breakdowns: - LOCATION_ID - UNSENDABLE_REASON - DUPLICATE_COUNT - SENT - CADENCE - CONTACT_METHOD - CONVERSIONS - CLIENT_ID - CLIENT_NAME - PATIENT_ID - PATIENT_NAME - CONTAINS_LEGACY_REMINDERS - RECIPIENT_ADDRESS - PROTOCOL_ID If results are requested inline, please use the provided `protocolRemindersReport` query.
emailSalesReportBooleanRuns the sales report and emails the results as an excel file to the given email address. This report supports the following breakdowns: - LOCATION_ID - PROVIDER_ID - REVENUE_CENTER_ID - PRODUCT_TYPE_ID - PRODUCT_CATEGORY_ID - PRODUCT_ID - DEPARTMENT_ID - CLIENT_ID - PAYROLL_ID - RDVM_ID If results are requested inline, please use the provided `salesReport` query.
emailTipsReportBooleanRuns the tips report and emails the results as an excel file to the given email address. This report supports the following breakdowns: - LOCATION_ID - TIPPED_PROVIDER_ID - CLIENT_ID If results are requested inline, please use the provided `tipsReport` query.
encounterEncounterencounterProducts[EncounterProduct]encounterSummaryStringencounterTypes[EncounterType]entitiesTagEntitiesTagentityTagEntityTagestimateEstimateestimateItems[EstimateItem]estimatePdfStringestimates[Estimate]estimatesTotalsEstimatesTotalsevents[Event!]eventsPaginatedEventConnectionexternalCommPreferencesClientExternalCommPreferencesValueexternalSearch[ExternalSearchResult]featureFlagFeatureFlagfeatureFlags[FeatureFlag]frequencies[Frequency!]fulfillmentSourceFulfillmentSourcegetInhouseDevices[LabDevice]getLatestLocationKpis[LocationKpi]getPatientDocumentsPatientDocumentConnectiongrossSalesReport[ReportRow]Runs the grossSales report and returns results inline. This report supports the following breakdowns: - LOCATION_ID - REVENUE_CENTER_ID - PROVIDER_ID - PRODUCT_ID - PRODUCT_TYPE_ID - PRODUCT_CATEGORY_ID - CLIENT_ID If results time out, please fetch smaller date ranges, otherwise please use the alternative `emailGrosssalesReport` query.
hospitalizations[Hospitalization]immunizationImmunizationimmunizationsDue[Immunization]inCollectionsBooleaninventoryAdjustmentInventoryAdjustmentinventoryAdjustments[InventoryAdjustment]invoiceLineItemReasons[InvoiceLineItemReason]invoicePdfStringisDaycareOpenBooleanlabModifiers[LabModifier]List lab modifiers for the current provider's org
labOrderLabOrderlabOrders[LabOrder]labResultLabResultlabResults[LabResult]labTrendsLabTrendRunWhere the patient's run has got to, or null if nothing has asked for one. Answers with every analyte the run covers. The engine merges the vendor's names, so it decides what an analyte is called and the caller matches on the name and aliases it reports. Reads only: `generateLabTrends` is what starts a run, so this is safe to poll.
lapsingPatients[Patient]latestDatasyncLogs[DatasyncLog]latestDeletionLogs[DeletionLog]ledgerEntries[LedgerEntry]ledgerEntryTotalsLedgerEntryTotalslegalEntities[LegalEntity]listEncountersEncounterConnectionlistEncountersCountIntlistImmunizationsImmunizationConnectionlistPatientProtocolsPatientProtocolConnectionlistProvidersProviderConnectionlistStockTransferTemplates[StockTransferTemplate]listTasksTaskConnectionlocationAppointmentTypes[AppointmentType]Get a list of appointments types which are either enabled globally, or enabled for the given location
locationChatMessages[LocationChatMessage]locationSchedules[LocationSchedule]locations[Location!]locationsDepartments[Department]macrosCountIntmandatoryConsentForms[String]masterProducts[MasterProduct]medicalRecordsSummaryStringmedicationMedicationmedicationsFilledReportMedicationsFilledReportResultmedicationsReportMedicationsReportResultmodalities[Modality]monographMonographmonographs[Monograph!]notifications[Notification]novaBoardRowCellsNovaBoardRowCellsGet cell statistics for a single NovaBoard sheet
openConversationsCountIntorderFlagOrderFlagorderItems[OrderItem]orderItemsTotalsOrderItemsTotalsorderLineItemsOrderItemConnectionordersPendingApprovalCountsOrdersCountsordersTotalsOrdersTotalsReturns a count of all orders based on a query, excludes datasync imported orders.
orgOrgLookup an org (defaults to viewer's)
orgDepartments[OrgDepartment]orgLabOrgLaborphanTransactionsMedicationIntegrationTransactionConnectionReturns a list of orphan transactions. Should only be used when the Cubex Two-Way integration is enabled
orphanedLabsCountIntorphanedLabsPaginatedLabResultConnectionoverdueTasksCountIntpacks[Pack]paidSalesReport[ReportRow]Runs the paidSales report and returns results inline. This report supports the following breakdowns: - LOCATION_ID - REVENUE_CENTER_ID - PROVIDER_ID - PRODUCT_ID - PRODUCT_TYPE_ID - PRODUCT_CATEGORY_ID - CLIENT_ID - PAYROLL_ID If results time out, please fetch smaller date ranges, otherwise please use the alternative `emailPaidsalesReport` query.
patientPatientpatientClinicalItemsPendingApprovalCountsPatientClinicalItemsPendingApprovalCountsRetrieve a patient's pending approval counts for clinical items. Should only be used when both the Cubex Two-Way integration and the patient orders feature are enabled; otherwise some fields may be unauthorized or null.
patientCompliances[PatientCompliance]patientCompliancesCountIntpatientCompliancesCsvUrlStringpatientComplicationPatientComplicationpatientConsentForms[ClientConsent]patientDiagnosticsDiagnosticConnectionGet diagnostics for a specific patient. Should only be used when the patient orders feature is enabled.
patientDocumentPatientDocumentpatientDocumentsPatientDocumentConnectionpatientEncounterProductsEncounterProductConnectionGet encounter products for a specific patient. Should only be used when the patient orders feature is enabled.
patientLabelStringpatientProtocols[PatientProtocol]patientQrCodeStringpatientTagPatientTagpatientTreatmentsTreatmentConnectionGet treatments for a specific patient. Should only be used when the patient orders feature is enabled.
paymentPaymentpaymentProviders[Provider]paymentReasons[PaymentReason]payments[Payment]paymentsTotalsPaymentsTotalsLists payments voided without corresponding account credit voided
pdfExtractionRulePdfExtractionRuleThe current org's AI PDF extraction rule, if it has one.
Get count of medications grouped by pharmacy status
phoneNumbers[PhoneNumber]planPreventionPlanplayPackDeferredRevenueCountIntplayPackDeferredRevenueReportPlayPackDeferredRevenueItemConnectionplumbsHandouts[PlumbsHandout]previewCadenceCadencepriceChanges[PriceChange]Lists price changes
problems[Problem]processorPayments[ProcessorPayment]productProductproductCategoryProductCategoryproductHistory[InventoryLog]productManufacturerProductManufacturerproductPackageProductPackageproductPackages[ProductPackage]productTypeProductTypeproducts[Product]productsCountIntproductsInStockCountDecimalprotocolReminders[ProtocolReminder]protocolRemindersCountIntprotocolRemindersReportJSONRuns the protocolReminders report and returns results inline. This report supports the following breakdowns: - LOCATION_ID - UNSENDABLE_REASON - DUPLICATE_COUNT - SENT - CADENCE - CONTACT_METHOD - CONVERSIONS - CLIENT_ID - CLIENT_NAME - PATIENT_ID - PATIENT_NAME - CONTAINS_LEGACY_REMINDERS - RECIPIENT_ADDRESS - PROTOCOL_ID If results time out, please fetch smaller date ranges, otherwise please use the alternative `emailProtocolremindersReport` query.
providerProviderLookup a specific provider by id. All users in Vetspire are listed as a provider and have an id.
providerAuthTokenStringproviderDepartments[Department]providerFeatureFlagProviderFeatureFlagproviderRoleProviderRoleproviders[Provider]purchaseOrderPurchaseOrderpurchaseOrders[PurchaseOrder]rabiesCertificateStringrabiesCertificates[String]rdvmRdvmrdvmContactRdvmContactrdvmDocumentRdvmDocumentrdvmsCountIntrecentScribeRecordings[ScribeRecording]The current provider's org's most recent successful scribe recordings that have a transcript (newest first, capped). Backs the AI Scribe test reference-encounter picker. Pass `mineOnly: true` to scope to the current provider's own recordings (the Profile picker). Pass `encounterTypeId` to scope to recordings of a single template.
recentVoiceCallsCountIntrefundedOrderItems[OrderItem]regeneratePatientProtocols[PatientProtocol]relationships[Relationship]reminders[Reminder]reservations[Reservation!]returnedOrderItems[ReturnedOrderItem]revenueCenterRevenueCenterrevenueCenterBudgets[RevenueCenterBudget]salesReportJSONRuns the sales report and returns results inline. This report supports the following breakdowns: - LOCATION_ID - PROVIDER_ID - REVENUE_CENTER_ID - PRODUCT_TYPE_ID - PRODUCT_CATEGORY_ID - PRODUCT_ID - DEPARTMENT_ID - CLIENT_ID - PAYROLL_ID - RDVM_ID If results time out, please fetch smaller date ranges, otherwise please use the alternative `emailSalesReport` query.
salesTypedReport[ReportRow]Runs the sales report and returns results inline. This report supports the following breakdowns: - LOCATION_ID - PROVIDER_ID - REVENUE_CENTER_ID - PRODUCT_TYPE_ID - PRODUCT_CATEGORY_ID - PRODUCT_ID - DEPARTMENT_ID - CLIENT_ID - PAYROLL_ID - RDVM_ID If results time out, please fetch smaller date ranges, otherwise please use the alternative `emailSalesReport` query.
scheduleTemplateScheduleTemplatescheduleTemplates[ScheduleTemplate!]scribeInstructionPreferences[EncounterType]searchLocationTags[LocationTag]searchMacros[Macro]searchPackages[ProductPackage]searchPrintnodeComputers[PrintnodeComputersField]Search for the computers associated with PrintNode account
searchPrintnodePrinters[PrintnodePrintersField!]Search for the printers associated with PrintNode account
searchProductCategories[ProductCategory]searchProductTypes[ProductType]searchProductables[Orderable]Search orderable products and, when `search_packages` is enabled, product packages. By default excludes products/product_types with `only_inventory: true`; pass `include_only_inventory: true` to include them (e.g. Purchase Orders).
searchProducts[Product]Search products. By default excludes products with `only_inventory: true` and products whose product_type has `only_inventory: true`. Pass `include_only_inventory: true` to include them (e.g. Purchase Orders).
searchTagGroups[EntityTagGroup!]selfCheckInLinkStringsentReminders[SentReminder]species[Species]stockLocationStockLocationstockLocations[StockLocation]stockTransferStockTransferstockTransferLocationReport[StockTransferLocationItem]stockTransferReportRecipients[StockTransferReportRecipient]stockTransferRequestStockTransferRequeststockTransferRequestStatusCountsStockTransferRequestStatusCountsstockTransferRequestsStockTransferRequestConnectionstockTransferTemplateStockTransferTemplatestockTransferTemplatesStockTransferTemplateConnectionstockTransferTemplatesCountIntstockTransfers[StockTransfer]storedLabTests[LabTest]stripeConnectionTokenStringstripeGetCustomerStripeCustomerstripePaymentIntentStripePaymentIntentstripePublishableKeyStringstripeReaderStripeReaderstripeReaders[StripeReader]taskTasktaskCategories[TaskCategory]taskGroups[TaskGroup]tasksCountInttipsReport[ReportRow]Runs the tips report and returns results inline. This report supports the following breakdowns: - LOCATION_ID - TIPPED_PROVIDER_ID - CLIENT_ID If results time out, please fetch smaller date ranges, otherwise please use the alternative `emailTipsReport` query.
totalClientsInttotalPatientsInttreatmentTreatmenttreatmentSheetTreatmentSheettreatmentSheetProviderTransfers[ProviderTransfer]treatmentSheetRowTreatmentSheetRowtreatmentSheetTemplates[TreatmentSheetTemplate]treatmentSummaryStringtreatments[Treatment]triggerTriggertriggers[Trigger]unreadConversations[Conversation]unreadConversationsCountIntunreadConversationsPaginatedConversationConnectionunreadNotificationsCountIntupennLabTests[Product]usageReportUsageReportvendorVendorvendors[Vendor]videoRoomTokenStringviewerViewerLookup the viewer
viewerSubscriptionViewerLookup the viewer
visitVisitvisitsReportVisitsReportItemConnectionvisitsReportCountIntvoidablePaymentMethods[PaymentMethod]