Get a template
curl --request GET \
--url https://api.healos.ai/ext-api/v1/templates/{templateId} \
--header 'X-API-Key: <api-key>'const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.healos.ai/ext-api/v1/templates/{templateId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.healos.ai/ext-api/v1/templates/{templateId}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": {
"id": "77777777-0000-0000-0000-000000000001",
"name": "SOAP Note",
"type": "custom",
"document_type": "note",
"description": "Subjective, Objective, Assessment, Plan",
"includes_prior_visit": false,
"sections": [
{
"key": "subjective",
"title": "Subjective",
"instructions": "Chief complaint and history of present illness."
}
]
}
}{
"error": "<string>",
"details": {}
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "Rate limit exceeded. Please retry after the window resets.",
"code": "daily_cap_reached",
"reset_at": "2026-10-28T00:00:00.000Z"
}Templates
Get a template
One template with its sections and each section’s instructions. Built-in templates, templates shared with your organization, and the key owner’s own private templates (the same set POST /sessions//notes/regenerate accepts as template_id). A template from another organization is a 404. Requires the templates:read scope.
GET
/
templates
/
{templateId}
Get a template
curl --request GET \
--url https://api.healos.ai/ext-api/v1/templates/{templateId} \
--header 'X-API-Key: <api-key>'const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.healos.ai/ext-api/v1/templates/{templateId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.healos.ai/ext-api/v1/templates/{templateId}"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": {
"id": "77777777-0000-0000-0000-000000000001",
"name": "SOAP Note",
"type": "custom",
"document_type": "note",
"description": "Subjective, Objective, Assessment, Plan",
"includes_prior_visit": false,
"sections": [
{
"key": "subjective",
"title": "Subjective",
"instructions": "Chief complaint and history of present illness."
}
]
}
}{
"error": "<string>",
"details": {}
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "Rate limit exceeded. Please retry after the window resets.",
"code": "daily_cap_reached",
"reset_at": "2026-10-28T00:00:00.000Z"
}| Requirement | Detail |
|---|---|
| Scope | templates:read (rolling out: not yet on api.healos.ai) |
| Rate limit | About 60 requests per minute per API key (shared by all endpoints; approximate) |
| Cost | Free |
Safety
- Writes data: No
- Safe to retry: Yes
- Contacts an outside system: None
- Dry run: Not needed (read-only).
Was this page helpful?

