List users with pagination

UserListPageResponse Viewer.Users.List(, )

GET/v1/viewer/users

Retrieves a paginated list of users with optional filtering by access level, email, name, and invitation source. Returns up to 100 users per request.

ParametersExpand Collapse

UserListParams parameters

string cursor

Base64 encoded cursor from previous response

string email

Filter by exact email match

string firstName

Filter by first name (contains match)

InvitedSource invitedSource

Filter by invitation source

string lastName

Filter by last name (contains match)

Level level

Filter by user level

Double limit

Number of results to return (1-100)

minimum1

maximum100

ReturnsExpand Collapse

class UserListPageResponse:

Paginated list of Viewer users

required Boolean HasMore

required IReadOnlyList<UserListResponse> Users

required Boolean CanManageStudies

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

required ClinicRole ClinicRole

User's clinical or organizational role

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 the user was invited - via dashboard UI or 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 Level Level

User access level. 'owner' has full control, '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

string Cursor

List users with pagination

UserListParams parameters = new();

var page = await client.Viewer.Users.List(parameters);
await foreach (var item in page.Paginate())
{
    Console.WriteLine(item);
}

{
  "hasMore": true,
  "users": [
    {
      "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"
    }
  ],
  "cursor": "cursor"
}

Returns Examples

{
  "hasMore": true,
  "users": [
    {
      "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"
    }
  ],
  "cursor": "cursor"
}