query { # Use this type in your queries someQuery { accountCreditHistory accountCreditsVoidedWithoutPaymentVoided accounts accountsCount accountsReceivableBalance }}accountCreditHistoryAccountCreditHistoryResponseLists account credits voided without corresponding payment voided
accountsClientConnectionaccountsCountIntactiveBoardRows[BoardRow]activeSubscriptionForOrgVetspireSubscriptionaddresses[Address]alertAlertallergies[Allergy]analytics[AnalyticsData]Lookup API keys for your org
appointmentAppointmentappointmentReminders[AppointmentReminder]appointmentTypeTagAppointmentTypeTagappointmentsReportJSONRuns 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 - PATIENT_ID If results time out, please fetch smaller date ranges, otherwise please use the alternative `emailAppointmentsReport` query.
asyncMedicalRecordAsyncMedicalRecordavailableTimes[AvailableTimeSlot]bills[Bill]boardCellBoardCellboardGroups[BoardGroup]boardRowBoardRowbookedDays[Date!]cadenceCadencecadences[Cadence]cages[Cage]callLogCallLogcallLogsCountIntcallLogsReportJSONRuns 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.
cardconnectVerifyCredentialsCardconnectVerifyCredentialsResultcareTeamRoles[CareTeamRole]ccTerminals[String]changelogsChangelogConnectioncheckDuplicatePhoneNumberBooleanLists sum of client account credits by location
clientConsentClientConsentclientReferralSourceClientReferralSourceclientTagClientTagclientTags[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.
clientsCountIntcomplicationComplicationconsentFormConsentFormThe `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.
couponCouponcoupons[Coupon]creditMemos[CreditMemo]creditMemosTotalsCreditMemoTotalscustomAppointmentFields[CustomAppointmentField]Get all custom appointment fields at the viewer's org
dashboardDashboarddepartments[Department]detailedCreditsCountIntdetailedCreditsReportDetailedCreditItemConnectiondetailedSalesRevenueCountIntdetailedSalesRevenueReportDetailedSalesRevenueItemConnectiondiagnosticDiagnosticdiagnostics[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 - PATIENT_ID 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.
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.
encounterEncounterencounterProducts[EncounterProduct]encounterSummaryStringencounterTypeEncounterTypeencounterTypes[EncounterType]estimateEstimateestimateItems[EstimateItem]estimatePdfStringestimates[Estimate]estimatesTotalsEstimatesTotalsevents[Event!]eventsPaginatedEventConnectionexternalCommPreferencesClientExternalCommPreferencesValueexternalSearch[ExternalSearchResult]featureFlagFeatureFlagfeatureFlags[FeatureFlag]fulfillmentSourceFulfillmentSourcegetInhouseDevices[LabDevice]getLatestLocationKpis[LocationKpi]hospitalizations[Hospitalization]immunizationImmunizationimmunizationsDue[Immunization]inCollectionsBooleaninventoryAdjustmentInventoryAdjustmentinventoryAdjustments[InventoryAdjustment]invoicePdfStringisDaycareOpenBooleanlabOrderLabOrderlabOrders[LabOrder]labResultLabResultlabResults[LabResult]lapsingPatients[Patient]latestDatasyncLogs[DatasyncLog]latestDeletionLogs[DeletionLog]ledgerEntries[LedgerEntry]ledgerEntryTotalsLedgerEntryTotalslegalEntities[LegalEntity]listEncountersEncounterConnectionlistTasksTaskConnectionlocationAppointmentTypes[AppointmentType]Get a list of appointments types which are either enabled globally, or enabled for the given location
locationChatMessages[LocationChatMessage]locationSchedules[LocationSchedule]locationTagLocationTaglocations[Location!]locationsDepartments[Department]macroMacromacrosCountIntmandatoryConsentForms[String]masterProducts[MasterProduct]medicalRecordsSummaryStringmedicationMedicationmedicationsReportMedicationsReportResultmodalities[Modality]monographMonographmonographs[Monograph!]newsletterNewsletternotifications[Notification]novaBoardNovaBoardopenConversationsCountIntorderFlagOrderFlagorderItems[OrderItem]orderItemsTotalsOrderItemsTotalsorderLineItemsOrderItemConnectionordersPendingApprovalCountsOrdersCountsRetrieve the number of pending approval items in a patient’s orders
ordersTotalsOrdersTotalsReturns 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
orphanedLabs[LabResult]overdueTasksCountIntpacks[Pack]patientPatientpatientCompliances[PatientCompliance]patientCompliancesCountIntpatientCompliancesCsvUrlStringpatientComplicationPatientComplicationpatientConsentForms[ClientConsent]patientDocumentPatientDocumentpatientLabelStringpatientPlanPatientPlanpatientProtocols[PatientProtocol]patientQrCodeStringpatientTagPatientTagpaymentPaymentpaymentProviders[Provider]payments[Payment]paymentsTotalsPaymentsTotalsLists payments voided without corresponding account credit voided
Get count of medications grouped by pharmacy status
phoneNumbers[PhoneNumber]planPreventionPlanplumbsHandouts[PlumbsHandout]preventionPlanPreventionPlanpreviewCadenceCadencepriceChanges[PriceChange]Lists price changes
problems[Problem]processorPayments[ProcessorPayment]productProductproductCategoryProductCategoryproductHistory[InventoryLog]productManufacturerProductManufacturerproductPackageProductPackageproductPackages[ProductPackage]productTypeProductTypeproducts[Product]productsCountIntproductsInStockCountDecimalprotocolProtocolprotocolReminders[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]providerRoleProviderRoleproviders[Provider]purchaseOrderPurchaseOrderpurchaseOrders[PurchaseOrder]rabiesCertificateStringrabiesCertificates[String]rdvmRdvmrdvmContactRdvmContactrdvmDocumentRdvmDocumentrdvmsCountIntrecentVoiceCallsCountIntrefundedOrderItems[OrderItem]regeneratePatientProtocols[PatientProtocol]relationships[Relationship]reminders[Reminder]reservationReservationreservations[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.
scheduleTemplateScheduleTemplatescheduleTemplates[ScheduleTemplate!]searchCoupons[Coupon]searchInventoryBuckets[InventoryBucket]searchLocationTags[String]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]searchProducts[Product]searchTagGroups[EntityTagGroup!]searchVendors[Vendor]selfCheckInLinkStringsentReminders[SentReminder]stockLocationStockLocationstockLocations[StockLocation]stockTransferStockTransferstockTransfers[StockTransfer]storedLabTests[LabTest]stripeConnectionTokenStringstripeGetCustomerStripeCustomerstripePaymentIntentStripePaymentIntentstripePublishableKeyStringstripeReaderStripeReaderstripeReaders[StripeReader]taskTasktaskCategories[TaskCategory]taskGroups[TaskGroup]tasksCountInttotalClientsInttotalPatientsInttreatmentTreatmenttreatmentSheetTreatmentSheettreatmentSheetProviderTransfers[ProviderTransfer]treatmentSheetTemplateTreatmentSheetTemplatetreatmentSheetTemplates[TreatmentSheetTemplate]treatmentSummaryStringtreatments[Treatment]triggerTriggertriggers[Trigger]unreadConversations[Conversation]unreadConversationsCountIntunreadNotificationsCountIntupennLabTests[Product]usageReportUsageReportvendorVendorvendors[Vendor]videoRoomTokenStringviewerViewerLookup the viewer
viewerSubscriptionViewerLookup the viewer
visitVisitvoidablePaymentMethods[PaymentMethod]