Shared
ModelsExpand Collapse
APIKeyReference { apiKeyId, description, isViewerEnabled } A reference to an API key with basic identifying information
A reference to an API key with basic identifying information
Unique API key identifier (UUIDv4 format)
Human-readable description of the API key
Whether this API key has access to the Viewer product
AssignableUserLevel = "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.
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.
ClinicRole = "Doctor" | "Physician" | "Surgeon" | 58 moreA user's clinical or organizational role within the clinic.
A user's clinical or organizational role within the clinic.
ExpressCustomerReference { expressCustomerId, expressCustomerName } A reference to an Express customer with basic identifying information
A reference to an Express customer with basic identifying information
Unique Express customer identifier. Format: cus_{32-hex-chars}
Name of the Express customer
InvitationExpiredFilter = "all" | "expired" | "not-expired"Filter by expiration status
Filter by expiration status
InvitationStatus = "sent" | "accepted" | "rejected" | "revoked"Lifecycle status of an invitation: 'sent', 'accepted', 'rejected', or 'revoked'.
Lifecycle status of an invitation: 'sent', 'accepted', 'rejected', or 'revoked'.
InvitedSource = "dashboard" | "api"How a user/invitation was created - via the dashboard UI ('dashboard') or the API ('api').
How a user/invitation was created - via the dashboard UI ('dashboard') or the API ('api').
Severity = "normal" | "high" | "stat"Priority level of a study. 'normal' for routine, 'high' for urgent, 'stat' for immediate attention.
Priority level of a study. 'normal' for routine, 'high' for urgent, 'stat' for immediate attention.
UserLevel = "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.
User access level. 'owner' has full control (dashboard-only, not assignable via API), 'admin' can manage users/settings, 'member' has standard access.
UserReference { email, userId, firstName, 4 more } A reference to a user with basic identifying information
A reference to a user with basic identifying information
User's email address
Unique user identifier. Format: usr_{32-hex-chars}
User's first name
User's last name
User's middle name
Name suffix (e.g., 'MD', 'Jr.')
Additional name suffix