Dentrix Developer Portal

API Exchange Program FAQs

Dentrix
Dentrix Ascend

What is the Dentrix API Program?

The Dentrix API Program is for software developers who already have or plan to create software that integrates with current versions of Dentrix. It offers a channel for Henry Schein ONE to provide Dentrix development tools to software developers and work with them to deliver shared value to our common customers.

How do I apply for the Dentrix API Program?

Fill out the form on Henry Schein ONE’s API page and click “Submit.”

After submitting an application, you’ll receive a confirmation email that it’s been received. The team reviews the application and will set up a meeting to review your use case and next steps. If approved, the Dentrix API Agreement is sent to be signed before receiving the API key.

API Exchange Vendors | Henry Schein One

What do I get as a Dentrix API member?

Members receive:

API key and credentials for Dentrix API
API documentation
Sample code and development tools
Access to the Developer Program Knowledge Base
Access to latest Dentrix software (for testing) and product manuals
Dentrix product support for install/config issues

Does a Dentrix API member have access to the latest versions of Dentrix?

Yes, DENTRIX API PROGRAM members can download and install the latest versions of Dentrix from our portal Downloads page.

What Dentrix APIs are available?

The Dentrix API Program offers the following API categories:

Read API List — Provides read-only access to supported table views, stored procedures, and DLL functions.
Write API List — Provides approved write access to supported table views, stored procedures, and DLL functions.
Scheduling API — Provides access to scheduling and appointment-related functionality. Not available to non-commercial participants.
Claims Summary API — Provides access to summarized claims data for practice level reporting and integration purposes.

What is a typical workflow?

Dentrix is an on-premise application, and the Dentrix API is designed for on-premise integrations. This means your team is responsible for building and then deploying your application locally within each office environment.

A typical integration flow looks like this:

Your signed application authenticates using the RegisterUser function, which allows GetConnectionString to return the credentials needed for ODBC access.
Your application then uses the API and/or ODBC connection to query Dentrix data.
From there, you determine how the data is used or transferred (for example, syncing it to a cloud-based system).

Is it possible to integrate a cloud-based application?

Yes. However, because the Dentrix API runs locally, the API member must install a local desktop application or service to securely communicate with the cloud-based application using industry’s best practices.

As a Dentrix API member, can I share my Dentrix API key with others?

No. The License Agreement prohibits transferring, selling, distributing, disclosing, sublicensing, or lending the API key; violations result in termination of the agreement and access.

Will the Dentrix API support assist our developers in building our application?

The focus of the program is to provide API access to third-party developers. We’re here to confirm your access setup, point you to the right endpoints, and help interpret API errors. We don’t build or debug your app code, but we can validate that the platform side (auth, connectivity, and API behavior) is working as expected.

What programming languages can be used with the Dentrix APIs?

Common languages like C#, C++, Java, etc., via password-protected ODBC connection.

Must API queries be run from the Dentrix server machine?

API queries can be run from any Dentrix server or workstation.

Are there tools for Java applications?

DENTRIX API PROGRAM provides an alternate JDBC driver that is available for download from the Resource Center > Downloads page. We do not develop that driver but have not had any issues.

Does Dentrix have an HL7 interface?

No, there is no HL7 interface supported.

What is the cost?

Two costs: a one-time registration and set-up fee ($5,000 READ, $5,000 WRITE) and a monthly royalty fee based on API categories selected. No start-up pricing, or access prior to joining the program. There is a singular pricing model that applies to all.

Under a API Access Plan do I pay usage for READ-ONLY usage?

Yes — usage charges apply regardless of usage type.

What are “protected” categories?

Certain software types (e.g., patient financing, credit card processing, insurance claim processing) or non-commercial API accounts aren’t allowed in the program or marketplace.

Is there an API program for other HS ONE products?

Yes — for Dentrix Ascend.

How do renewals for my membership work?

Commercial memberships do not require renewal—the contract remains active unless canceled with 60 days’ notice. Non-commercial memberships are billed annually on the original start date unless canceled.

Is there a trial option?

No trial option exists; however, the full list of API functions is published on the FAQ.

Does the Dentrix API work with the Canadian version?

Yes.

Can I access formulas, algorithms, or business logic code?

Henry Schein ONE does not share or divulge what it considers to be intellectual property (IP) of Dentrix.

Can I access the Dentrix Data Dictionary or Schema?

No, Henry Schein ONE does not share or divulge the data dictionary or schema.

How do I submit a ticket to Dentrix API Support?

Login at the Dentrix API Portal: https://ddp.dentrix.com/
Go to Resources > Support Ticket
Submit the Support ticket form choosing a Dentrix Category

What is the Dentrix Ascend Developer Program?

The Dentrix Ascend API Program is for software developers who already have or plan to create software that integrates with Dentrix Ascend. It provides a channel for Henry Schein ONE to offer Dentrix Ascend development tools and collaborate to deliver value to shared customers.

How do I apply?

Click the “Sign Up” link:

API Exchange Vendors | Henry Schein One

After you submit an application, you’ll receive a confirmation email that it has been received for review. The team reviews the application and will set up a meeting to review your use case and next steps. If approved, the Agreement is sent to be signed before proceeding with your initial Sandbox Access to begin development and testing.

What do I get as a member?

Members receive:

API key and credentials to access the Dentrix Ascend API
API documentation
Sample code and other API development tools
Initial Access to a Dentrix Ascend sandbox for development & testing. (60 Days)
Dentrix Ascend product support for installation and configuration issues

Does a member have access to the latest versions of Dentrix Ascend?

Yes — the sandbox will always have the latest version of Dentrix Ascend and the latest documentation.

What Dentrix APIs are available?

There is currently one type of API available through the Dentrix Ascend Developer Program. The Dentrix Ascend data API provides a library of functions that read and write data from the Dentrix Ascend database. After signing an agreement, you receive portal access to available endpoints across: Clinical, Schedule, Treatment, Insurance, Financial, Patient, and General categories.

Reference link: Public API

What is a typical workflow?

Dentrix Ascend is a cloud-based platform, so integrations are fully remote and do not require on-premise deployment. A typical flow looks like this:

Your application authenticates using API credentials (API key and organization context).
Your app makes HTTPS requests to Ascend API endpoints to retrieve or update data (e.g., patients, appointments, procedures).
You implement your own logic for syncing, storing, or acting on that data within your system (e.g., triggering workflows, analytics, or patient communications).
Optionally, you can subscribe to Streaming API events to receive near real-time updates instead of relying solely on polling.

Key Differences vs Dentrix (on-premise) API:

Deployment: No local installation required; integrations run externally against cloud endpoints.
Access Method: RESTful HTTPS API instead of ODBC/database access.
Authentication: API key-based vs local user registration and connection strings.
Data Flow: Designed around API calls and event-driven patterns rather than direct database queries.
Scalability: One integration can support multiple locations without per-office installs.

As a member, can I share my Dentrix Ascend API key with others?

No. The Developer Agreement prohibits transferring, selling, distributing, disclosing, leasing, syndicating, sub-syndicating, lending, or sublicensing the Dentrix Ascend API (including the API key) or redistributing data retrieved through the API to unauthorized parties. Violations result in termination of the agreement, API key, and access privileges.

What programming languages can be used for developing an integration with the Dentrix Ascend APIs?

The Dentrix Ascend API is accessed through REST API endpoints, with POST and GET requests sent/returned in JSON format.

Are there tools available for Java-based applications to use to connect to the API?

You can program in any language that supports JSON.

Does Dentrix Ascend have a Health Level 7 (HL7) interface?

No — Dentrix Ascend does not currently provide or support an HL7 interface.

What is the cost?

A one-time $5,000 registration and set-up fee
A monthly $47 fee for each Dentrix Ascend Location, which includes 30K calls and 3GB data per location/per month
Overage charges for excess usage at $0.0018/call and $1.00/GB data

Can I certify my product?

No — there currently is no application certification process available to API members.

Is there a Developer Program or APIs for other Henry Schein ONE products?

Currently there are two programs: Dentrix and Dentrix Ascend.

Is there a Beta program available for Dentrix Ascend customers to test my product?

No. Henry Schein ONE does not perform Beta testing for third-party products. You can do your own internal testing in your sandbox.

Can I receive a customer list from Henry Schein ONE for prospecting purposes?

No. Henry Schein ONE does not make customer lists available to any third parties. You will be added to our API website as an approved vendor.

Will Henry Schein Field Sales Consultants (FSCs) promote or sell my product to dentists?

No — due to the volume of products/services being sold, it isn’t feasible for FSCs and other Dentrix Ascend sales reps to promote/sell members’ applications. Henry Schein ONE does not ensure traction in sales channels; introduction and product training in sales channels are reserved for highest-level partnerships.

Is there an annual membership fee?

No. The only fees members pay are their initial registration fee and monthly access fees.

Can I gain access to formulas, algorithms or business logic code used to generate reports and other calculated values in Dentrix Ascend?

No. Henry Schein ONE does not share or divulge what it considers to be Dentrix Ascend intellectual property (IP).

Can I have access to the Dentrix Ascend Schema?

The Dentrix Ascend API documentation here contains the available schemas.

How do I submit a ticket to Ascend API Support for API issues or questions?

Please submit all new API-related issues through our Ascend API Ticket Submission Form (login required.)

Stored Procedure/Tableview/DLL	Description	Category	Availability
sp_getoperatoryschedexceptions	Operatory Schedule Exceptions	Appointments	G6+
sp_getoperatoryschedule	Operatory Default Schedule	Appointments	G6+
v_appointment	Patient appointment	Appointments	G5+
v_appointment_checklist	Appointment Check List	Appointments	G5.2+
v_appointment_types	Appointment Types	Appointments	G5.2+
v_appt_status_codes	Appointment Status Codes	Appointments	G5+
v_initial_reasons	Appointment Initial Reasons	Appointments	G5.2+
sp_getappointmentunitsize	Appointment Unit Size	Appointments	G6+
sp_getapptamountsetting	Appointment Amount Setting	Appointments	G6+
sp_getpracticeschedexceptions	Practice Schedule Exceptions	Appointments	G6+
sp_getpracticeschedule	Practice Default Schedule	Appointments	G6+
sp_getproviderschedule	Provider Default Schedule	Appointments	G6+
sp_getprovschedexceptions	Provider Schedule Exceptions	Appointments	G6+
v_operatory	Operatories	Appointments	G5+
sp_getprovtimeblockdefault	Provider Time Blocks (Default)	Appointments	G6+
sp_getprovtimeblockschedule	Provider Time Blocks (Specific Week)	Appointments	G6+
v_practice_information	Practice	Appointments	G5.2+
sp_appointments	Modified Appointments	Appointments	G5.2+
sp_getallpatientsappointmentinfo	All Patients' Appointment Information	Appointments	G5+
sp_getpatientappointmentinfo	Patient's Appointment Information	Appointments	G5.2+
sp_getpatientnextapptdatetime	Patient's Next Appointment Date and Time	Appointments	G5.2+
sp_getpatientpreviousapptdatetime	Patient's Previous Appointment Date/Time	Appointments	G5+
v_appt	Appointments	Appointments	G6+
v_appt_book_events	Appointment Book Events	Appointments	G5.2+
sp_apptbookdaynote	Appointment Book Day Note	Appointments	G5+
sp_getallpatientrecalls	All Patients' Recall Information	Appointments	G5+
sp_getpatientrecalls	Patient Recall	Appointments	G5.2+
v_patient_recall	All Patients' Recall Information (View)	Appointments	G5+
v_recall_type	Recall Type	Appointments	G5+
v_lab	Dental Labs	Clinical	G6+
v_lab_case	Dental Lab Cases	Clinical	G5+
v_docattach	Document Attachments	Clinical	G6.3+
v_document	Document Information	Clinical	G5+
sp_getpatienttreatmentplan	Patient's Treatment Planned Procedures	Clinical	G5+
v_patientalertlinks	Patient Alert Links	Clinical	G5+
v_patientalerts	Patient Alerts	Clinical	G6.3+
sp_getpatientmedalerts	Patient's Medical Alerts	Clinical	G5+
v_patient_prescription	Patient Prescriptions	Clinical	G6+
sp_getperioexam	Perio Exam Data	Clinical	G6+
v_perio	Perio Exam Records	Clinical	G6+
v_document_types	Document Types	Clinical	G5+
v_proccodes	Procedure Codes	Clinical	G6+
v_rx_patient	Patient Prescriptions	Clinical	G5+
v_rxlist	Practice Prescriptions	Clinical	G5+
v_prescriptiontemplates	Practice Prescription (Prescription Template)	Clinical	G6+
v_notes	Notes	Clinical	G6+
sp_getpatientofficejournal	Patient's Office Journal Entries	Clinical	G5+
sp_getproviderofficejournal	Provider's Office Journal Entries	Clinical	G5+
v_account_notes	Account / Guarantor Notes	Clinical	G6+
v_clinical_notes	Patient Clinical Notes	Clinical	G5.2+
v_practice_medical_alerts	Practice Medical Alerts	Clinical	G5.2+
DENTRIXAPI_Letters_LaunchQuickLetter	Launch patient Quick Letters	Practice Setup	G6.3+
ui_registerintegrationcomponent	Registers a chart panel in Dentrix	Clinical	G6.3+
v_lcmdef	Lab case manager definition	Clinical	G5+
v_lcmlink	Lab case manager	Clinical	G5+
v_lcmlog	Lab case manager event information	Clinical	G5+
sp_patient	Patient Demographics (Stored Procedure)	Demographics	G5.1+
v_patient	Patient Demographics (View)	Demographics	G5+
v_address	Patient Address	Demographics	G5.2+
sp_getallproviders	Providers	Demographics	G5+
sp_getallproviderspecialties	Provider Specialty	Demographics	G5+
sp_getallprovidersproduction	All Providers' Production	Demographics	G5+
sp_getprovidermonthtotals	Provider Analysis Totals	Demographics	G5+
sp_getproviderproduction	Provider's Production	Demographics	G5+
v_provider	Providers (View)	Demographics	G5+
v_staff	Staff	Demographics	G5+
v_timeclockpunches	Time Clock Punches	Demographics	G6.3+
v_timeclocksetup	Time Clock Setup	Demographics	G6.3+
v_patients	Patient Demographics (View)	Demographics	G5+
sp_getpatientbalance	Patient's Balance	Financial	G5+
v_guarantor_balance	Guarantor's Balance	Financial	G5+
sp_getpatientadjustments	Patient's Adjustments	Financial	G5+
sp_getaccountpayments	Account Payments	Financial	G5+
sp_getpatientprocedures	Patient's Completed Procedures	Financial	G5+
v_proclog	Ledger Transactions	Financial	G6+
v_billing_types	Billing Types	Financial	G5.2+
v_adjustment_types	Adjustment Types	Financial	G5.2+
v_payment_types	Payment Types	Financial	G5.2+
sp_getguarpmtagreement	Guarantor's Payment Agreement	Financial	G5+
sp_accountbalance	Family balance	Financial	G6.3+
v_pmtagree	Payment agreement	Financial	G5+
v_fees	Fee schedules	Financial - Fee Schedules	G6.3+
v_fee_schedule_names	Fee schedule names	Financial - Fee Schedules	G5+
v_employers	Employers	Insurance	G5.2+
sp_getallpatientsinsuranceinfo	All Patients' Dental Insurance Information	Insurance	G5+
v_patient_insurance	Patient's Dental Insurance Information	Insurance	G5+
v_coverage_table	Insurance Coverage Tables	Insurance	G6+
v_insured	Insured Subscribers	Insurance	G5+
v_insurance_plan_notes	Insurance Plan Notes	Insurance	G6+
v_insurance_plans	Insurance Plans	Insurance	G5+
sp_calcpatientccoverride	Patient continuing care override appointment details	Insurance	G6+
sp_getreferralofficejournal	Referral's Office Journal Entries	Referral	G5+
sp_getallreferralspecialties	Referral Specialty	Referral	G5+
sp_getpatientreferrals	Patient's Referrals	Referral	G5+
sp_getreferralsource	Referral Source	Referral	G5+
v_referral	Referral Source (View)	Referral	G5+
v_referral_acts	Referral Gratuity Acts	Referral	G6.3+
v_referral_specialty	Referral Specialty	Referral	G5+
v_gratacts	Referral gratuities	Referral	G5+
v_gratuity	Gratuity setup information	Referral	G5+
sp_getletters	Launch letters setup	Practice Setup	G6.3+
v_recallstatus	Continuing care status	Practice Setup	G5+
v_providerspecialties	Provider specialities	Practice Setup	G6.3+
v_proccodecategories	Procedure code categories	Practice Setup	G6.3+
v_dentdiagcodecategories	Diagnostic code categories	Practice Setup	G5+
v_custprocedurenotedesc	Description for custom procedure notes	Practice Setup	G5+
ui_selectreferral	Launch Select Referral dialog box	Practice Setup	G6.3+
ui_selectprovider	Launch Select Provider dialog box	Practice Setup	G6.3+
ui_selectpatient	Launch Select Patient dialog box	Practice Setup	G6.3+
ui_selectguarantor	Launch Select Guarantor dialog box	Practice Setup	G6.3+
ui_quickletterexport	Patient quick letter (with export to specified path or file name)	Practice Setup	G6.3+
ui_moreinfo	Launch More Information Dialog	Practice Setup	G6.3+
ui_letterexport	Export letter data	Practice Setup	G6.3+
ui_launchreportdialog	Launch letters setup	Practice Setup	G6.3+
ui_launchquickletter	Launch patient Quick Letters	Practice Setup	G6.3+
ui_launchdentrixmodule	Launch Dentrix Module	Practice Setup	G6.3+
ui_launchapptbookforapptid	Launch appointment Book with Appointment selected	Practice Setup	G6.3+

Stored Procedure/Tableview/DLL	Description	Category	Availability
sp_setappointmentstatus	Update Appointment Status	Appointments	G5+
sp_addappointmentnote	Add/Replace Appointment Note	Appointments	G5+
sp_appendappointmentnote	Append Appointment Note	Appointments	G5+
sp_addapptbookdaynote	Add/Replace Appointment Book Day Note	Appointments	G5+
sp_appendapptbookdaynote	Append Appointment Book Day Note	Appointments	G5+
sp_deleteapptbookdaynote	Delete Appointment Book Day Note	Appointments	G5+
DENTRIXAPI_LaunchApptBookForApptId	Launch Appointment Book with Appointment selected	Appointments	G6.2+
DENTRIXAPI_ImportFileToDocumentCenter	Import Document to Document Center	Clinical	G5+
DENTRIXAPI_Letters_ExecuteReport	Export letter data	Clinical	G6.2+
DENTRIXAPI_Letters_LaunchQuickLetterEx	Patient quick letter (with export to specified path or file name)	Clinical	G6.2+
DENTRIXAPI_Letters_LaunchReportDialog	Opens the letter or custom list setup dialog box for a specified letter	Clinical	G6.2+
DENTRIXAPI_RegisterIntegrationComponent	Register Chart Panel Integration Component	Clinical	G6.2+
DENTRIXAPI_UninstallIntegrationComponent	Uninstall Chart Panel Integration Component	Clinical	G6.2+
sp_addpracticeprescription	Add Prescription Template	Clinical	G6.1+
sp_addpatientprescription	Add Patient Prescription	Clinical	G6.1+
sp_deletepatientprescription	Delete Patient Prescription	Clinical	G6.1+
DENTRIXAPI_AddClinicalNote	Add Clinical Note	Clinical	G6+
DENTRIXAPI_SetClinicalNoteText	Replace Clinical Note	Clinical	G6+
DENTRIXAPI_AppendClinicalNote	Append Clinical Note	Clinical	G6+
DENTRIXAPI_UpdateClinicalNoteProv	Set Provider for Clinical Note	Clinical	G6+
DENTRIXAPI_DeleteClinicalNote	Delete Clinical Note	Clinical	G6+
DENTRIXAPI_UpdateClinicalNoteDate	Update Clinical Note Date	Clinical	G6+
sp_addpatientofficejournal	Add Patient Office Journal Entry	Clinical	G5+
sp_addproviderofficejournal	Add Provider Office Journal Entry	Clinical	G5+
sp_deleteofficejournal	Delete Office Journal Entry	Clinical	G5+
sp_addpatientmedicalalert	Add/Replace Patient Medical Alert	Clinical	G6.1+
sp_clearpatientmedicalalert	Clear Patient Medical Alert	Clinical	G6.3+
sp_editpatientmedicalalerts	Edit Patient Medical Alerts	Clinical	G6.3+
sp_addpatientmedicalnote	Add/Replace Patient Medical Note	Clinical	G6.2+
sp_appendpatientnote_ex	Append Patient Note (New)	Clinical	G5+
sp_deletepatientmedicalnote	Delete Patient Medical Alert Note	Clinical	G6.3+
sp_addpatientnote	Add/Replace Patient Note	Clinical	G5+
sp_appendpatientnote	Append Patient Note (Deprecated)	Clinical	G5+
sp_clearpatientnote	Clear Patient Note	Clinical	G5+
sp_appendpatientmedicalnote	Append Patient Medical Note	Clinical	G6.3+
sp_deletepatientnote	Delete Patient Note	Clinical	G6.3+
sp_replaceclinicalnotetext	Update Clinical Note Text	Clinical	G6.3+
DENTRIXAPI_LaunchDentrixApp	Launch Dentrix Module with Patient Selected	Demographics	G6.2+
DENTRIXAPI_MoreInfo	Launch More Information Dialog	Demographics	G6.2+
DENTRIXAPI_SelectGuarantor	Launch Select Guarantor Dialog	Demographics	G6.2+
DENTRIXAPI_SelectPatient	Launch Select Patient Dialog	Demographics	G6.2+
DENTRIXAPI_SelectProvider	Launch Select Provide Dialog	Demographics	G6.2+
DENTRIXAPI_ChangePatientBillingType	Update Patient Billing Type	Demographics	G6.2+
sp_assignpatientaddress	Assign/Create Patient Address	Demographics	G6.3+
sp_createpatient	Create Patients/Family Members/New Families	Demographics	G6.3+
sp_editpatient	Edit Existing Patient	Demographics	G6.3+
sp_addreferralofficejournal	Add Referral Office Journal Entry	Referral	G5+
DENTRIXAPI_SelectReferral	Launch Select Referral Dialog	Referral	G6.2+
sp_addrefbydocreferralsource	Add ‘Referred By Dr./Other' Referral Source	Referral	G5+
sp_addreftoreferralsource	Add ‘Referred To' Referral Source	Referral	G5+
sp_updaterefbydoctorreferralsource	Update ‘Ref By Dr./Other' Referral Source	Referral	G5+
sp_updatereftoreferralsource	Update ‘Referred To' Referral Source	Referral	G5+
sp_addrefbypatientreferral	Add ‘Referred By Patient' Referral for Patient	Referral	G5+
sp_addrefbydoctorreferral	Add ‘Ref By Dr./Other' Referral for Patient	Referral	G5+
sp_addreftoreferral	Add referred to referral	Referral	G5+