Retrieve a user by ID

UserRetrieveResponse Viewer.Users.Retrieve(, )

GET/v1/viewer/users/{userId}

Retrieves a single user by their unique user ID. Returns the complete user object with all profile information, permissions, and status.

ParametersExpand Collapse

UserRetrieveParams parameters

required string userID

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

ReturnsExpand Collapse

class UserRetrieveResponse:

A user in the Viewer system with study management permissions

required Boolean CanManageStudies

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

required ClinicRole ClinicRole

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

Accepts one of the following:

required DateTimeOffset? CreatedAt

Timestamp when the user was created

formatdate-time

required string Email

User's email address for login and notifications

required string FirstName

User's first name

minLength1

required Boolean HasDashboardAccess

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

required InvitedSource InvitedSource

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

Accepts one of the following:

required DateTimeOffset? LastLoginAt

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

formatdate-time

required string LastName

User's last name

minLength1

required UserLevel Level

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

Accepts one of the following:

required string UserID

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

string MiddleName

User's middle name (optional)

minLength1

string PhoneNumber

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

string Suffix1

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

minLength1

string Suffix2

Additional name suffix (optional)

minLength1

Retrieve a user by ID

UserRetrieveParams parameters = new()
{
    UserID = "usr_1234567890abcdef1234567890abcdef"
};

var user = await client.Viewer.Users.Retrieve(parameters);

Console.WriteLine(user);

{
  "canManageStudies": true,
  "clinicRole": "Radiologist",
  "createdAt": "2024-01-15T10:00:00Z",
  "email": "dr.johnson@hospital.org",
  "firstName": "Sarah",
  "hasDashboardAccess": true,
  "invitedSource": "api",
  "lastLoginAt": "2024-03-15T09:00:00Z",
  "lastName": "Johnson",
  "level": "member",
  "userId": "usr_1234567890abcdef1234567890abcdef",
  "middleName": "Marie",
  "phoneNumber": "5551234567",
  "suffix1": "MD",
  "suffix2": "FACR"
}

Returns Examples

{
  "canManageStudies": true,
  "clinicRole": "Radiologist",
  "createdAt": "2024-01-15T10:00:00Z",
  "email": "dr.johnson@hospital.org",
  "firstName": "Sarah",
  "hasDashboardAccess": true,
  "invitedSource": "api",
  "lastLoginAt": "2024-03-15T09:00:00Z",
  "lastName": "Johnson",
  "level": "member",
  "userId": "usr_1234567890abcdef1234567890abcdef",
  "middleName": "Marie",
  "phoneNumber": "5551234567",
  "suffix1": "MD",
  "suffix2": "FACR"
}