Getting Started

Welcome to the Dental PMS API documentation. This guide will help you get started with the API, from authentication to making your first request.

Overview

The Dental PMS API is a RESTful API that allows you to manage all aspects of a dental practice — patients, scheduling, clinical records, insurance, billing, and more.

Base URL:

https://api.example.com/api/v1/{org_id}

All tenant-scoped endpoints require an org_id path parameter, which is your organization's UUID.

What You Can Do

Authentication

Learn how to authenticate API requests using Bearer tokens.

Quickstart

Make your first API call in under 5 minutes.

Pagination

Learn how to paginate through large result sets.

Error Handling

Understand error responses and how to handle them.

API Conventions

All request and response bodies use JSON (Content-Type: application/json)
Dates use ISO 8601 format (YYYY-MM-DD for dates, YYYY-MM-DDTHH:mm:ssZ for datetimes)
Times use HH:mm:ss format (24-hour, wall-clock time)
UUIDs are used for all entity identifiers
Soft-deleted entities have a non-null deleted_at timestamp and are excluded from list queries by default