Document types

Before you start

• Every request needs a bearer token from POST /authenticates. See Authentication.
• Requests take the practice's subdomain and a location_id. See Institutions, syncs, and locations.

Overview

The document types endpoint lists the document categories in a practice's health record system. These categories organize documents such as patient consent forms, treatment plans, X-rays and insurance claims.

Example use cases

• Set a document type when you add a patient document, so the file lands in the right folder and staff can find it.

Sample response

{
  "code": true,
  "description": null,
  "error": null,
  "data": [
    {
      "id": 1,
      "name": "Health History and Patient Forms",
      "active": true
    }
  ],
  "count": 1
}