Skip to main content
GET
List audit events
Safety
  • Writes data: No
  • Safe to retry: Yes
  • Contacts an outside system: None. Reads your organization’s API audit log in HealOS.
  • Dry run: Not needed (read-only).
Lists your organization’s External API audit log, newest first: which API key called which route, on which record id, with what status. Rows hold ids and route templates only (/patients/{patientId}), never request bodies, query values or record contents. Every row belongs to the calling key’s own organization. Narrow the list with key_id, resource_type and resource_id, or a since / until window. For the next (older) page, pass the previous page’s meta.next_cursor as cursor. Rows can take a few seconds to appear: HealOS writes them in batches. From the CLI: healos audit list. Errors: Error catalog.

Authorizations

X-API-Key
string
header
required

API key obtained from /api/v1/ext-api-keys

Query Parameters

key_id
string<uuid>

Only events from this API key (its id, from the API Keys page).

resource_type
string

Only events about this kind of record: patient, document, appointment, provider, note, session, eligibility_check, prior_auth_request or ehr_action.

Pattern: ^[a-z_]{1,48}$
Example:

"patient"

resource_id
string

Only events about this record id. Combine with resource_type.

Pattern: ^[A-Za-z0-9_.:-]{1,64}$
since
string<date-time>

Events at or after this time (ISO 8601).

Example:

"2026-10-01T00:00:00Z"

until
string<date-time>

Events before this time (ISO 8601).

limit
string
default:50

Events per page, 1-200 (default 50).

Pattern: ^\d+$
Example:

"50"

cursor
string

meta.next_cursor from the previous page. Omit for the newest events.

Pattern: ^[1-9]\d{0,18}$

Response

A page of audit events

data
object[]
required
meta
object
required