canonical: https://jentic.com/apis/dentimax.com/dentimax

# DentiMax Communicator API

Jentic publishes the only available OpenAPI specification for DentiMax Communicator API, keeping it validated and agent-ready. DentiMax Communicator is the patient-communication layer attached to the DentiMax dental practice management suite, used by US dental practices for scheduling and outbound patient messaging. The API exposes three endpoints covering listing appointments, scheduling appointments, and sending messages directly to a patient. Authentication uses a header API key, and the surface is intentionally narrow to support reminder, confirmation, and booking flows.

## For AI agents

List and schedule DentiMax appointments and send outbound messages to patients from external apps and agents.

## Scope

Does not handle clinical charting, imaging, billing, or insurance claims - use for DentiMax appointment listing, scheduling, and patient messaging only.

## Capabilities

- List upcoming appointments via GET /appointments
- Schedule a new appointment for a patient with POST /appointments
- Send a direct message to a patient through POST /messages
- Drive appointment reminder workflows from external schedulers
- Support DentiMax practices with custom booking widgets

## Use cases

### Custom Booking Widget

Embed a custom booking widget on a practice website that calls POST /appointments to schedule directly into DentiMax. Practices retain control of branding and form fields while ensuring the booking lands in the same schedule the front desk works from.

Example prompt: Collect patient and slot details from the widget, then POST them to /appointments and confirm the response on screen.

### Patient Reminder Workflow

Run a reminder workflow that pulls upcoming appointments via GET /appointments and sends a personalised reminder for each via POST /messages. This reduces no-shows for DentiMax practices that prefer in-system messaging over a third-party SMS gateway.

Example prompt: Pull tomorrow's appointments via GET /appointments, then call POST /messages for each patient with a reminder body.

### Outbound Patient Messaging

Send ad-hoc messages to patients straight from a CRM or operations console via POST /messages, without the staff member needing to log in to the DentiMax UI. Useful for follow-up notes, recall outreach, and one-off operational messages.

Example prompt: Call POST /messages with the target patient id and message body, and surface the delivery result back to the operator.

### AI Agent Integration via Jentic

A front-desk assistant agent can use Jentic to schedule a new appointment and send a confirmation message in one conversation. Jentic resolves the API key from the vault and chains the two calls so the agent does not handle credentials or read API docs to act.

Example prompt: Use Jentic to search for 'schedule a dentimax appointment', call POST /appointments, then call POST /messages with a confirmation body.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | /appointments | List appointments |
| POST | /appointments | Schedule a new appointment |
| POST | /messages | Send a message to a patient |

## Key resources

- **Appointments** — List and schedule appointments
- **Messages** — Send direct messages to patients

## Why Jentic

- **Setup:** Wiring the DentiMax Communicator API by hand means learning its API key header and building the calls for listing appointments, scheduling, and sending patient messages yourself. Through Jentic you install once, import the DentiMax Communicator API from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** DentiMax carries the appointment and message details in the request body rather than a scoped URL path, so you limit the agent to the operations it needs, such as listing appointments, and scheduling or messaging is included only if you add those operations.
- **Credential handling:** Your DentiMax API key is stored once, encrypted, by your own Jentic One instance and injected into the request header at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'schedule a dental appointment' or 'message a patient', and Jentic returns the matching DentiMax operation with its input schema so the agent calls the right endpoint without reading the docs.

## Related APIs

- **Dentally API** — UK and APAC dental practice management API with 31 endpoints across patients, appointments, invoices, and NHS claims.
- **DrChrono API** — US EHR with broad scheduling, clinical, and billing surface.
- **Twilio Messaging API** — SMS delivery for reminders when DentiMax in-system messaging is not enough.
- **SendGrid Mail API** — Transactional email for confirmations and recall emails.

## FAQ

### Why is there no official OpenAPI spec for DentiMax Communicator API?

DentiMax does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call DentiMax Communicator API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the DentiMax Communicator API use?

The DentiMax Communicator API uses an API key passed in a request header. Through Jentic, the key is stored in the encrypted vault and injected at execution time, so it never enters the agent's prompt.

### Can I schedule appointments with the DentiMax Communicator API?

Yes. POST /appointments creates a new appointment in the practice schedule. GET /appointments returns the existing list, suitable for confirming the booking landed in the right slot.

### Can I send a message to a patient through the DentiMax Communicator API?

Yes. POST /messages sends an outbound message to a specified patient, useful for reminders, confirmations, and recall outreach. Pair it with GET /appointments to drive a full reminder workflow.

### Does the DentiMax Communicator API expose patient records?

This OpenAPI spec covers appointments and messages only - there are no patient CRUD endpoints in the documented surface. Patient identifiers used in /appointments and /messages must come from the DentiMax practice management system.

### How do I drive a reminder workflow through Jentic?

Run `pip install jentic`, search for 'list dentimax appointments', then loop over the response and call POST /messages per patient. Jentic handles the API key for both operations from the vault.

### Can I limit what my agent is allowed to do with the DentiMax Communicator API?

Yes. Because you run Jentic One yourself, you decide which of the DentiMax operations your agent may call, so you can grant read-only access to GET /appointments while withholding POST /appointments and POST /messages. The appointment and message details travel in the request body rather than a scoped URL path, so scoping happens at the operation level: scheduling and patient messaging are available only if you choose to add those operations. Your API key is held by your own instance and injected at execution time, keeping it out of the agent's prompt.