Developers

The REST API: keys, scopes, reading, writing and bulk import.

The CuspFlow REST API

A REST API over your clinic's own data, for pulling it into Excel, Power BI or a reporting tool and for migrating records in from another practice management system. Base URL, a working quickstart, the response shape and how versioning works.

API keys and scopes

Creating, scoping, restricting, rotating and revoking a CuspFlow API key, how a key's bound staff role sets a hard ceiling on what it can ever do, and the rate limits that apply to every plan.

Reading data from the API

Cursor pagination, choosing fields, sorting, filtering with comparison and list operators, polling for changes, deleted and imported records, and how date-only parameters resolve in your clinic's own timezone.

Writing data through the API

Creating, updating and deleting records over the CuspFlow API, which fields each resource accepts and why some are refused, retrying safely with an idempotency key, and using ETags so a concurrent edit cannot be silently overwritten.

Bulk import over the API

Migrating patients, appointments, families and your price catalog into CuspFlow over HTTP in batches of up to 500 rows, with per-row results, a required idempotency key and a 7-day rollback that refuses to delete anything already in use.

API errors

Every error code the CuspFlow API returns, what causes it, and whether retrying will help. Errors are RFC 9457 problem documents, and the type link in each one points at its own entry on this page.

API resource reference

The 22 resources the CuspFlow API exposes, which verbs and scopes each one takes, where to get the full field list, and the handful of things about the data model that will save you a wasted afternoon.