REST API for GuideLab — clinics, labs, workflows, finance, files, and integrations.

The GuideLab API is a REST API for the GuideLab dental lab management platform. It powers everything the web and desktop apps do: managing orders and patients, running production workflows, handling invoicing and payments, uploading clinical files, and integrating with scanners and third‑party tools.

Conventions

• Protocol — HTTPS only. Requests and responses are JSON unless an endpoint explicitly deals with file uploads or downloads.
• Authentication — every non‑public endpoint requires an authenticated session cookie or native device credential. See Authentication.
• Multi‑tenant — GuideLab is multi‑tenant. Your session is scoped to an organization (a lab or a clinic), and endpoints operate on the data for that organization. Some routes are restricted to a specific organization type or role.
• Pagination — list endpoints share a common page/limit contract. See Pagination.
• Errors — failures use a consistent JSON envelope and standard HTTP status codes. See Errors.

API reference

The API reference is generated directly from the API's OpenAPI 3.1 specification. Endpoints are grouped by area — Orders, Patients, Partnerships, Invoices, Production, Files, and many more — with the full request and response schema for each operation.

Using the docs with AI

Every page can be exported as Markdown for use with an LLM:

• Copy for AI / Open buttons at the top of each page.
• /llms-full.txt — the entire documentation as a single plain‑text file.
• Append .mdx to any page URL to get its Markdown source.