Skip to content
Avara
Get started
API Reference

Viewer

ViewerStudies

Create a new study
post/v1/viewer/studies
List studies with pagination
get/v1/viewer/studies
Retrieve a study by ID
get/v1/viewer/studies/{studyId}
Update a study
patch/v1/viewer/studies/{studyId}
Cancel a study
post/v1/viewer/studies/cancel
Uncancel a study
post/v1/viewer/studies/uncancel
Generate a viewer reroute URL
post/v1/viewer/studies/reroute-url
Retrieve a study by DICOM UID
get/v1/viewer/studies/by-uid/{studyInstanceUid}

ViewerUsers

Create and invite a new user
post/v1/viewer/users
List users with pagination
get/v1/viewer/users
Retrieve a user by ID
get/v1/viewer/users/{userId}
Update a user
patch/v1/viewer/users/{userId}
Revoke user access
post/v1/viewer/users/revoke-access
Reactivate a user
post/v1/viewer/users/reactivate

ViewerUsersInvitations

List user invitations
get/v1/viewer/users/invitations
Retrieve an invitation by ID
get/v1/viewer/users/invitations/{invitationId}
Update an invitation
patch/v1/viewer/users/invitations/{invitationId}
Revoke an invitation
post/v1/viewer/users/invitations/revoke