API Permissions
Security Permissions
The security permissions for the API are organized differently from those in Open Dental.
| Permission | Methods | Details |
|---|---|---|
| Read All | AccountModules GET PatientBalances Allergies GET AllergyDefs GET Appointments GET (single/multiple) Appointments GET SlotsWebSched Appointments GET Slots Appointments GET ASAP Appointments GET WebSched ApptFields GET ApptFieldDefs GET ChartModules GET ProgNotes ChartModules GET PatientInfo Clinics GET Commlogs GET Definitions GET DiscountPlanSubs GET Diseases GET DiseaseDefs GET Documents GET FamilyModules GET Insurance Medications GET MedicationPats GET Operatories GET PatFields GET PatientNotes GET Patients GET (single/multiple) Patients GET Simple Popups GET Preferences GET ProcedureLogs GET Providers GET Recalls GET List Referrals GET Reports GET Aging Schedules GET (single/multiple) Sheets GET Signalods GET Subscriptions GET Subscriptions POST Subscriptions PUT Userods GET |
All GET methods except queries. These are throttled at different rates for different users. |
| AllOthers | Allergies DELETE Allergies POST Allergies PUT AllergyDefs POST ApptFieldDefs POST Carriers POST Carriers PUT Clinics PUT DiscountPlanSubs POST Diseases DELETE Diseases POST Diseases PUT DiseaseDefs POST Documents POST DownloadMount Documents POST DownloadSftp Documents POST SetByUrl Documents POST Thumbnails Documents POST UploadSftp Employers POST Employers PUT Medications POST MedicationPats DELETE MedicationPats POST PatFields PUT PatientNotes PUT Providers POST Providers PUT RefAttaches POST Sheets POST DownloadSftp Userods POST |
Any method not listed under a different permission. |
| Comm | Appointments PUT Break Appointments PUT Confirm Appointments PUT Note ApptFields PUT Commlogs POST Popups POST Recalls PUT Status |
|
| Documents | Documents POST Upload (not any other Documents methods) |
Because each upload consumes bandwidth. |
| Queries | Queries POST Queries PUT ShortQuery |
|
| Appointments | Appointments POST Appointments POST WebSched Appointments PUT |
|
| Insurance | ClaimProcs PUT InsAdjust Claims DELETE Claims PUT Claims PUT Split Claims PUT Status InsSubs DELETE InsSubs POST InsSubs PUT PatPlans DELETE PatPlans POST InsVerifies PUT |
These are complex and rarely used. |
| Patients | Patients POST Patients PUT |
|
| Payments | Payments POST | Added in version 21.3 |
| PayPlans | PayPlans POST | Added in version 21.3 |
| ProcedureLogs | ProcedureLogs POST ProcedureLogs PUT ProcedureLogs DELETE |
Added in version 21.4 |
The normal Open Dental permissions are used for logging API actions, but they do not restrict the API from making changes. For example, date restrictions do not apply.