Shared

class ApiKeyReference:

A reference to an API key with basic identifying information

required string ApiKeyID

Unique API key identifier (UUIDv4 format)

formatuuid

required string Description

Human-readable description of the API key

minLength1

Boolean IsClinicalContextEnrichmentEnabled

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

Boolean IsViewerEnabled

Whether this API key has access to the Viewer product

enum 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.

enum ClinicRole:

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

class EphemeralHangingProtocol:

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

required ViewerLayout Layout

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

One of the following:

required IReadOnlyList<string> ViewportAssignments

class ExpressCustomerReference:

A reference to an Express customer with basic identifying information

required string ExpressCustomerID

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

required string ExpressCustomerName

Name of the Express customer

minLength1

enum InvitationExpiredFilter:

Filter by expiration status

enum InvitationStatus:

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

enum InvitedSource:

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

enum Severity:

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

enum UserLevel:

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

class UserReference:

A reference to a user with basic identifying information

required string Email

User’s email address

required string UserID

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

string FirstName

User’s first name

string LastName

User’s last name

string MiddleName

User’s middle name

string Suffix1

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

string Suffix2

Additional name suffix

enum ViewerLayout:

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

Shared

ModelsExpand Collapse