Base URL

https://api.mydentalpms.com/api

🔐 Authentication

▼

JWT Bearer Token

  • All requests must include the Authorization header with a valid JWT token.
  • Format: Authorization: Bearer {token}
  • Tokens expire after 24 hours. Use the refresh endpoint to obtain a new token.
  • Refresh tokens are valid for 30 days.

Obtaining a Token

  • POST to /auth/login with valid credentials (email and password).
  • Response includes token and refreshToken.
  • Use /auth/refresh endpoint with refresh token to get a new access token.
Method Endpoint Description
POST /auth/login Authenticate user and receive JWT token
POST /auth/register Register new user account
POST /auth/refresh Refresh access token using refresh token
POST /auth/2fa/verify Verify two-factor authentication code

⚡ Rate Limiting

▼

API requests are rate-limited based on authentication status. Rate limits reset every minute.

Authenticated Requests

5/minute

General Requests

100/minute

Public Endpoints

30/minute

🔑 Auth Endpoints

▼
Method Endpoint Description
POST /auth/login Authenticate user and receive JWT token
POST /auth/register Register new user account
POST /auth/refresh Refresh access token using refresh token
POST /auth/2fa/verify Verify two-factor authentication code

👥 Patients

▼
Method Endpoint Description
GET /patients List all patients with pagination
POST /patients Create new patient record
GET /patients/:id Retrieve specific patient details
PUT /patients/:id Update patient information
DELETE /patients/:id Delete patient record
GET /patients/search Search patients by name, email, or phone

📅 Scheduling

▼
Method Endpoint Description
GET /scheduling/appointments List appointments with filters
POST /scheduling/appointments Create new appointment
GET /scheduling/appointments/:id Retrieve appointment details
PUT /scheduling/appointments/:id Update appointment
DELETE /scheduling/appointments/:id Cancel appointment

🏥 Clinical

▼
Method Endpoint Description
GET /clinical/charting/:patientId Get patient dental charting records
POST /clinical/charting/:patientId Create or update dental charting
GET /clinical/treatment-plans List treatment plans
POST /clinical/treatment-plans Create new treatment plan

💰 Billing

▼
Method Endpoint Description
GET /billing/charges Retrieve billing charges
POST /billing/charges Create new charge
GET /billing/payments List payments received
POST /billing/payments Record new payment
GET /billing/aging Get accounts receivable aging report

📋 Claims

▼
Method Endpoint Description
GET /claims List insurance claims
POST /claims Create new claim
POST /claims/:id/submit Submit claim to insurance carrier
POST /claims/:id/scrub Run claim scrubbing validation
GET /claims/denials Retrieve denied claims
GET /claims/aging Get claims aging report
GET /claims/era Retrieve Electronic Remittance Advice

💊 Prescriptions

▼
Method Endpoint Description
GET /prescriptions List prescriptions
POST /prescriptions Create new prescription
POST /prescriptions/:id/send Send prescription to pharmacy
GET /prescriptions/interactions/:patientId Check drug interactions for patient
GET /prescriptions/controlled-log Get controlled substance usage log

🔗 Referrals

▼
Method Endpoint Description
GET /referrals List patient referrals
POST /referrals Create referral to specialist
GET /referrals/network Get specialist network directory
POST /referrals/network Add specialist to network
GET /referrals/analytics Get referral analytics and reports

👨‍⚕️ Staff

▼
Method Endpoint Description
GET /staff List staff members
POST /staff Add new staff member
GET /staff/:id/credentials Get staff professional credentials
GET /staff/timesheets List timesheet entries
POST /staff/timesheets Submit timesheet entry
GET /staff/:id/performance Get staff performance metrics

📝 Consent

▼
Method Endpoint Description
GET /consent/templates List consent form templates
POST /consent/templates Create consent template
POST /consent/sign Record signed consent
GET /consent/compliance Get consent compliance status

🌙 End of Day (EOD)

▼
Method Endpoint Description
GET /eod/summary Get EOD summary report
GET /eod/reconciliation Get reconciliation data
POST /eod/close Close business day
GET /eod/checklist Get EOD closing checklist

🎯 Treatment Plans

▼
Method Endpoint Description
GET /treatment-plans List all treatment plans
POST /treatment-plans Create treatment plan
POST /treatment-plans/:id/present Present treatment plan to patient
GET /treatment-plans/analytics Get treatment plan analytics

📄 Statements

▼
Method Endpoint Description
GET /statements List patient statements
POST /statements/generate Generate new statement
GET /statements/payment-plans List payment plans
POST /statements/payment-plans Create payment plan
GET /statements/collections Get collections data

📦 Inventory

▼
Method Endpoint Description
GET /inventory List inventory items
POST /inventory Add inventory item
GET /inventory/alerts Get low stock alerts
POST /inventory/order Create purchase order
GET /inventory/vendors Get vendor information

📢 Marketing

▼
Method Endpoint Description
GET /marketing/reputation Get online reputation metrics
GET /marketing/reviews Retrieve patient reviews
POST /marketing/review-request Send review request to patient
GET /marketing/campaigns List marketing campaigns
POST /marketing/campaigns Create new campaign

🖼️ Imaging

▼
Method Endpoint Description
GET /imaging List imaging studies
POST /imaging Upload imaging study
GET /imaging/:id Retrieve imaging study details

📊 Reports

▼
Method Endpoint Description
GET /reports/production Get production analytics report
GET /reports/collections Get collections report
GET /reports/scheduling Get scheduling analytics report