List your EHR connections
curl --request GET \
--url https://api.healos.ai/ext-api/v1/ehr/connections \
--header 'X-API-Key: <api-key>'const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.healos.ai/ext-api/v1/ehr/connections', 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/ehr/connections"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": [
{
"ehr": "athena",
"name": "athenahealth",
"status": "connected",
"action_count": 123
}
]
}{
"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"
}EHR
List your EHR connections
Every EHR in the catalog with whether your organization has it connected. Status only: never credentials, sessions or which user connected it.
GET
/
ehr
/
connections
List your EHR connections
curl --request GET \
--url https://api.healos.ai/ext-api/v1/ehr/connections \
--header 'X-API-Key: <api-key>'const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};
fetch('https://api.healos.ai/ext-api/v1/ehr/connections', 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/ehr/connections"
headers = {"X-API-Key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": [
{
"ehr": "athena",
"name": "athenahealth",
"status": "connected",
"action_count": 123
}
]
}{
"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 | ehr:read |
| 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. Reads your organization’s connection status in HealOS; your EHR is not contacted.
- Dry run: Not needed (read-only).
Was this page helpful?

