Get All Templates

Retrieve all available scribing templates.

Overview

Retrieve a list of all available scribing templates. The public_id of the selected template will be required when submitting a scribing request.

Query Parameters

• page (integer, optional) - Page number (default: 1).
• limit (integer, optional) - Number of results per page (default: 50).

Example Response

{
    "items": [
        {
            "public_id": "68ee2ab4-e154-4b84-840d-f41806bbfd63",
            "name": "HPI",
            "description": "Basic history and physical template."
        },
        {
            "public_id": "e998125f-43d2-42e4-9446-a9004af13e0b",
            "name": "Dental Exam",
            "description": "Dental horse exam, including general oral exam such as jaw, face, etc."
        }
    ],
    "has_next": false,
    "current_page": 1,
    "items_per_page": 50
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-API-Version

string

required

API versioning is required. Include the header X-API-Version with current version value in all requests.

Example:

"v1"

Query Parameters

page

integer

default:1

limit

integer

default:50

Response

200 - application/json

List of templates.

items

object[]

Show child attributes

items.public_id

string

items.name

string

items.description

string

has_next

boolean

current_page

integer

items_per_page

integer