Skip to content
Avara
Get started
API Reference

Shared

ModelsExpand Collapse
class APIKeyReference: …

A reference to an API key with basic identifying information

api_key_id: str

Unique API key identifier (UUIDv4 format)

formatuuid
description: str

Human-readable description of the API key

minLength1
is_clinical_context_enrichment_enabled: Optional[bool]

Whether this API key has a clinical-context enrichment webhook configured

is_viewer_enabled: Optional[bool]

Whether this API key has access to the Viewer product

Literal["admin", "member"]

User access level assignable via the API. ‘admin’ can manage users/settings, ‘member’ has standard access. ‘owner’ is dashboard-only and cannot be assigned via the API.

One of the following:
"admin"
"member"
Literal["Doctor", "Physician", "Surgeon", 58 more]

A user’s clinical or organizational role within the clinic.

One of the following:
"Doctor"
"Physician"
"Surgeon"
"Radiologist"
"Cardiologist"
"Neurologist"
"Urologist"
"Gynecologist"
"Endocrinologist"
"Oncologist"
"Radiation Oncologist"
"Hematologist"
"Gastroenterologist"
"Pulmonologist"
"Nephrologist"
"Rheumatologist"
"Dermatologist"
"Ophthalmologist"
"Otolaryngologist"
"Pediatrician"
"Obstetrician"
"Psychiatrist"
"Anesthesiologist"
"Emergency Medicine Physician"
"Family Medicine Physician"
"Internal Medicine Physician"
"Pathologist"
"Nuclear Medicine Physician"
"Pain Management Specialist"
"Infectious Disease Specialist"
"Immunologist"
"Physician Assistant"
"Nurse Practitioner"
"Certified Registered Nurse Anesthetist"
"Psychologist"
"Medical Assistant"
"Scribe"
"Registered Nurse"
"Nurse Manager"
"Patient Care Coordinator"
"Imaging Technologist"
"Laboratory Technician"
"Medical Laboratory Scientist"
"Pathologists' Assistant"
"Phlebotomist"
"Pharmacist"
"Pharmacy Technician"
"Physical Therapist"
"Occupational Therapist"
"Speech-Language Pathologist"
"Respiratory Therapist"
"Nutritionist"
"Front Desk Operator"
"Revenue Cycle Manager"
"Administrative Director"
"Administrative Assistant"
"Legal Administrator"
"IT Administrator"
"IT Support"
"Software Engineer"
"Other"
class EphemeralHangingProtocol: …

Optional single-monitor hanging protocol applied when the ephemeral viewer loads. Omitted = no protocol. Invalid shape is rejected.

layout: ViewerLayout

Viewport grid layout for an ephemeral hanging protocol. Wire values match first-party viewer layouts (‘1x1’ through ‘4x4’).

One of the following:
"1x1"
"1x2"
"1x3"
"1x4"
"2x1"
"2x2"
"2x3"
"2x4"
"3x1"
"3x2"
"3x3"
"3x4"
"4x1"
"4x2"
"4x3"
"4x4"
viewport_assignments: List[Optional[str]]
class ExpressCustomerReference: …

A reference to an Express customer with basic identifying information

express_customer_id: str

Unique Express customer identifier. Format: cus_{32-hex-chars}

express_customer_name: str

Name of the Express customer

minLength1
Literal["all", "expired", "not-expired"]

Filter by expiration status

One of the following:
"all"
"expired"
"not-expired"
Literal["sent", "accepted", "rejected", "revoked"]

Lifecycle status of an invitation: ‘sent’, ‘accepted’, ‘rejected’, or ‘revoked’.

One of the following:
"sent"
"accepted"
"rejected"
"revoked"
Literal["dashboard", "api"]

How a user/invitation was created - via the dashboard UI (‘dashboard’) or the API (‘api’).

One of the following:
"dashboard"
"api"
Literal["normal", "high", "stat"]

Priority level of a study. ‘normal’ for routine, ‘high’ for urgent, ‘stat’ for immediate attention.

One of the following:
"normal"
"high"
"stat"
Literal["owner", "admin", "member"]

User access level. ‘owner’ has full control (dashboard-only, not assignable via API), ‘admin’ can manage users/settings, ‘member’ has standard access.

One of the following:
"owner"
"admin"
"member"
class UserReference: …

A reference to a user with basic identifying information

email: str

User’s email address

user_id: str

Unique user identifier. Format: usr_{32-hex-chars}

first_name: Optional[str]

User’s first name

last_name: Optional[str]

User’s last name

middle_name: Optional[str]

User’s middle name

suffix1: Optional[str]

Name suffix (e.g., ‘MD’, ‘Jr.’)

suffix2: Optional[str]

Additional name suffix

Literal["1x1", "1x2", "1x3", 13 more]

Viewport grid layout for an ephemeral hanging protocol. Wire values match first-party viewer layouts (‘1x1’ through ‘4x4’).

One of the following:
"1x1"
"1x2"
"1x3"
"1x4"
"2x1"
"2x2"
"2x3"
"2x4"
"3x1"
"3x2"
"3x3"
"3x4"
"4x1"
"4x2"
"4x3"
"4x4"