Skip to content
Avara
Get started
API Reference
Viewer

Users

Create and invite a new user
viewer.users.invite(UserInviteParams**kwargs) -> UserInviteResponse
POST/v1/viewer/users
List users with pagination
viewer.users.list(UserListParams**kwargs) -> SyncCursorUsers[UserListResponse]
GET/v1/viewer/users
Retrieve a user by ID
viewer.users.retrieve(struser_id) -> UserRetrieveResponse
GET/v1/viewer/users/{userId}
Update a user
viewer.users.update(struser_id, UserUpdateParams**kwargs) -> UserUpdateResponse
PATCH/v1/viewer/users/{userId}
Revoke user access
viewer.users.revoke_access(UserRevokeAccessParams**kwargs) -> UserRevokeAccessResponse
POST/v1/viewer/users/revoke-access
Reactivate a user
viewer.users.reactivate(UserReactivateParams**kwargs) -> UserReactivateResponse
POST/v1/viewer/users/reactivate
ModelsExpand Collapse
class UserInviteResponse: …

Response for inviting a user to Viewer. Level is restricted to admin/member since owners cannot be invited via API.

can_manage_studies: bool

Whether the user has permission to create, update, and manage studies

clinic_role: ClinicRole

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"
created_at: Optional[datetime]

Timestamp when the user was created

formatdate-time
email: str

User’s email address for login and notifications

first_name: str

User’s first name

minLength1
has_dashboard_access: bool

Whether the user can access the dashboard interface. Required for admin users

invited_source: InvitedSource

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

One of the following:
"dashboard"
"api"
last_login_at: Optional[datetime]

Timestamp of user’s last login, null if never logged in

formatdate-time
last_name: str

User’s last name

minLength1
level: AssignableUserLevel

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"
user_id: str

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

middle_name: Optional[str]

User’s middle name (optional)

minLength1
phone_number: Optional[str]

User’s phone number (10-15 digits, optional)

suffix1: Optional[str]

Name suffix (e.g., ‘Jr.’, ‘Sr.’, ‘III’) - optional

minLength1
suffix2: Optional[str]

Additional name suffix (optional)

minLength1
class UserListResponse: …

A user in the Viewer system with study management permissions

can_manage_studies: bool

Whether the user has permission to create, update, and manage studies

clinic_role: ClinicRole

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"
created_at: Optional[datetime]

Timestamp when the user was created

formatdate-time
email: str

User’s email address for login and notifications

first_name: str

User’s first name

minLength1
has_dashboard_access: bool

Whether the user can access the dashboard interface. Required for admin users

invited_source: InvitedSource

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

One of the following:
"dashboard"
"api"
last_login_at: Optional[datetime]

Timestamp of user’s last login, null if never logged in

formatdate-time
last_name: str

User’s last name

minLength1
level: UserLevel

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"
user_id: str

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

middle_name: Optional[str]

User’s middle name (optional)

minLength1
phone_number: Optional[str]

User’s phone number (10-15 digits, optional)

suffix1: Optional[str]

Name suffix (e.g., ‘Jr.’, ‘Sr.’, ‘III’) - optional

minLength1
suffix2: Optional[str]

Additional name suffix (optional)

minLength1
class UserRetrieveResponse: …

A user in the Viewer system with study management permissions

can_manage_studies: bool

Whether the user has permission to create, update, and manage studies

clinic_role: ClinicRole

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"
created_at: Optional[datetime]

Timestamp when the user was created

formatdate-time
email: str

User’s email address for login and notifications

first_name: str

User’s first name

minLength1
has_dashboard_access: bool

Whether the user can access the dashboard interface. Required for admin users

invited_source: InvitedSource

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

One of the following:
"dashboard"
"api"
last_login_at: Optional[datetime]

Timestamp of user’s last login, null if never logged in

formatdate-time
last_name: str

User’s last name

minLength1
level: UserLevel

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"
user_id: str

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

middle_name: Optional[str]

User’s middle name (optional)

minLength1
phone_number: Optional[str]

User’s phone number (10-15 digits, optional)

suffix1: Optional[str]

Name suffix (e.g., ‘Jr.’, ‘Sr.’, ‘III’) - optional

minLength1
suffix2: Optional[str]

Additional name suffix (optional)

minLength1
class UserUpdateResponse: …

A user in the Viewer system with study management permissions

can_manage_studies: bool

Whether the user has permission to create, update, and manage studies

clinic_role: ClinicRole

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"
created_at: Optional[datetime]

Timestamp when the user was created

formatdate-time
email: str

User’s email address for login and notifications

first_name: str

User’s first name

minLength1
has_dashboard_access: bool

Whether the user can access the dashboard interface. Required for admin users

invited_source: InvitedSource

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

One of the following:
"dashboard"
"api"
last_login_at: Optional[datetime]

Timestamp of user’s last login, null if never logged in

formatdate-time
last_name: str

User’s last name

minLength1
level: UserLevel

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"
user_id: str

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

middle_name: Optional[str]

User’s middle name (optional)

minLength1
phone_number: Optional[str]

User’s phone number (10-15 digits, optional)

suffix1: Optional[str]

Name suffix (e.g., ‘Jr.’, ‘Sr.’, ‘III’) - optional

minLength1
suffix2: Optional[str]

Additional name suffix (optional)

minLength1
class UserRevokeAccessResponse: …

Response for revoking user access in Viewer

success: bool
message: Optional[str]
class UserReactivateResponse: …

Response for reactivating a user in Viewer

success: bool
message: Optional[str]

UsersInvitations

List user invitations
viewer.users.invitations.list(InvitationListParams**kwargs) -> SyncCursorInvitations[InvitationListResponse]
GET/v1/viewer/users/invitations
Retrieve an invitation by ID
viewer.users.invitations.retrieve(strinvitation_id) -> InvitationRetrieveResponse
GET/v1/viewer/users/invitations/{invitationId}
Update an invitation
viewer.users.invitations.update(strinvitation_id, InvitationUpdateParams**kwargs) -> InvitationUpdateResponse
PATCH/v1/viewer/users/invitations/{invitationId}
Revoke an invitation
viewer.users.invitations.revoke(InvitationRevokeParams**kwargs) -> InvitationRevokeResponse
POST/v1/viewer/users/invitations/revoke
ModelsExpand Collapse
class InvitationListResponse: …

A pending user invitation in the Viewer system

can_manage_studies: bool

Whether the invited user will have permission to manage studies

clinic_id: str

UUID of the clinic this invitation belongs to

formatuuid
clinic_role: ClinicRole

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"
created_at: Optional[datetime]

Timestamp when the invitation was created

formatdate-time
email: str

Email address the invitation was sent to

expiry: Optional[datetime]

When the invitation expires, null if no expiration

formatdate-time
first_name: str

Invited user’s first name

minLength1
has_dashboard_access: bool

Whether the invited user will have dashboard access

invitation_id: str

Unique invitation identifier. Format: inv_{32-hex-chars}

invited_source: InvitedSource

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

One of the following:
"dashboard"
"api"
inviter_id: str

User ID of the person who sent the invitation. Format: usr_{32-hex-chars}. Null if invited via API

last_name: str

Invited user’s last name

minLength1
level: UserLevel

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"
status: InvitationStatus

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

One of the following:
"sent"
"accepted"
"rejected"
"revoked"
updated_at: Optional[datetime]

Timestamp when the invitation was last updated

formatdate-time
user_id: str

Pre-generated user ID for this invitation. Format: usr_{32-hex-chars}. This ID is assigned at invitation creation and will become the user’s permanent ID upon acceptance

invited_by_api_key_id: Optional[str]

UUID of the API key used to send this invitation. Null if sent via dashboard

formatuuid
middle_name: Optional[str]

Invited user’s middle name (optional)

minLength1
phone_number: Optional[str]

Invited user’s phone number (optional)

suffix1: Optional[str]

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

minLength1
suffix2: Optional[str]

Additional name suffix - optional

minLength1
class InvitationRetrieveResponse: …

A pending user invitation in the Viewer system

can_manage_studies: bool

Whether the invited user will have permission to manage studies

clinic_id: str

UUID of the clinic this invitation belongs to

formatuuid
clinic_role: ClinicRole

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"
created_at: Optional[datetime]

Timestamp when the invitation was created

formatdate-time
email: str

Email address the invitation was sent to

expiry: Optional[datetime]

When the invitation expires, null if no expiration

formatdate-time
first_name: str

Invited user’s first name

minLength1
has_dashboard_access: bool

Whether the invited user will have dashboard access

invitation_id: str

Unique invitation identifier. Format: inv_{32-hex-chars}

invited_source: InvitedSource

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

One of the following:
"dashboard"
"api"
inviter_id: str

User ID of the person who sent the invitation. Format: usr_{32-hex-chars}. Null if invited via API

last_name: str

Invited user’s last name

minLength1
level: UserLevel

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"
status: InvitationStatus

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

One of the following:
"sent"
"accepted"
"rejected"
"revoked"
updated_at: Optional[datetime]

Timestamp when the invitation was last updated

formatdate-time
user_id: str

Pre-generated user ID for this invitation. Format: usr_{32-hex-chars}. This ID is assigned at invitation creation and will become the user’s permanent ID upon acceptance

invited_by_api_key_id: Optional[str]

UUID of the API key used to send this invitation. Null if sent via dashboard

formatuuid
middle_name: Optional[str]

Invited user’s middle name (optional)

minLength1
phone_number: Optional[str]

Invited user’s phone number (optional)

suffix1: Optional[str]

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

minLength1
suffix2: Optional[str]

Additional name suffix - optional

minLength1
class InvitationUpdateResponse: …

A pending user invitation in the Viewer system

can_manage_studies: bool

Whether the invited user will have permission to manage studies

clinic_id: str

UUID of the clinic this invitation belongs to

formatuuid
clinic_role: ClinicRole

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"
created_at: Optional[datetime]

Timestamp when the invitation was created

formatdate-time
email: str

Email address the invitation was sent to

expiry: Optional[datetime]

When the invitation expires, null if no expiration

formatdate-time
first_name: str

Invited user’s first name

minLength1
has_dashboard_access: bool

Whether the invited user will have dashboard access

invitation_id: str

Unique invitation identifier. Format: inv_{32-hex-chars}

invited_source: InvitedSource

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

One of the following:
"dashboard"
"api"
inviter_id: str

User ID of the person who sent the invitation. Format: usr_{32-hex-chars}. Null if invited via API

last_name: str

Invited user’s last name

minLength1
level: UserLevel

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"
status: InvitationStatus

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

One of the following:
"sent"
"accepted"
"rejected"
"revoked"
updated_at: Optional[datetime]

Timestamp when the invitation was last updated

formatdate-time
user_id: str

Pre-generated user ID for this invitation. Format: usr_{32-hex-chars}. This ID is assigned at invitation creation and will become the user’s permanent ID upon acceptance

invited_by_api_key_id: Optional[str]

UUID of the API key used to send this invitation. Null if sent via dashboard

formatuuid
middle_name: Optional[str]

Invited user’s middle name (optional)

minLength1
phone_number: Optional[str]

Invited user’s phone number (optional)

suffix1: Optional[str]

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

minLength1
suffix2: Optional[str]

Additional name suffix - optional

minLength1
class InvitationRevokeResponse: …

Response for revoking an invitation in Viewer

success: bool
message: Optional[str]