List users with pagination

client.viewer.users.list(?, ?): CursorUsers<UserListResponse { canManageStudies, clinicRole, createdAt, 12 more } >

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

query: UserListParams { cursor, email, firstName, 4 more }

cursor?: string

Base64 encoded cursor from previous response

email?: string

Filter by exact email match

firstName?: string

Filter by first name (contains match)

invitedSource?: InvitedSource

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

Accepts one of the following:

"dashboard"

"api"

lastName?: string

Filter by last name (contains match)

level?: UserLevel

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:

"owner"

"admin"

"member"

limit?: number

Number of results to return (1-100)

minimum1

maximum100

ReturnsExpand Collapse

UserListResponse { canManageStudies, clinicRole, createdAt, 12 more }

A user in the Viewer system with study management permissions

canManageStudies: boolean

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

clinicRole: ClinicRole

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

Accepts one of the following:

"Doctor"

"Physician"

"Surgeon"

"Radiologist"

"Cardiologist"

"Neurologist"

"Urologist"

"Gynecologist"

"Endocrinologist"

"Oncologist"

"Radiation Oncologist"

"Hematologist"

"Gastroenterologist"

"Pulmonologist"

"Nephrologist"

"Rheumatologist"

"Dermatologist"

"Ophthalmologist"

"Otolaryngologist"

"Pediatrician"

"Obstetrician"

"Psychiatrist"

"Anesthesiologist"

"Emergency Medicine Physician"

"Family Medicine Physician"

"Internal Medicine Physician"

"Pathologist"

"Nuclear Medicine Physician"

"Pain Management Specialist"

"Infectious Disease Specialist"

"Immunologist"

"Physician Assistant"

"Nurse Practitioner"

"Certified Registered Nurse Anesthetist"

"Psychologist"

"Medical Assistant"

"Scribe"

"Registered Nurse"

"Nurse Manager"

"Patient Care Coordinator"

"Imaging Technologist"

"Laboratory Technician"

"Medical Laboratory Scientist"

"Pathologists' Assistant"

"Phlebotomist"

"Pharmacist"

"Pharmacy Technician"

"Physical Therapist"

"Occupational Therapist"

"Speech-Language Pathologist"

"Respiratory Therapist"

"Nutritionist"

"Front Desk Operator"

"Revenue Cycle Manager"

"Administrative Director"

"Administrative Assistant"

"Legal Administrator"

"IT Administrator"

"IT Support"

"Software Engineer"

"Other"

createdAt: string | null

Timestamp when the user was created

formatdate-time

email: string

User's email address for login and notifications

firstName: string

User's first name

minLength1

hasDashboardAccess: boolean

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

invitedSource: InvitedSource

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

Accepts one of the following:

"dashboard"

"api"

lastLoginAt: string | null

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

formatdate-time

lastName: string

User's last name

minLength1

level: UserLevel

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:

"owner"

"admin"

"member"

userId: string

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

middleName?: string

User's middle name (optional)

minLength1

phoneNumber?: string

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

suffix1?: string

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

minLength1

suffix2?: string

Additional name suffix (optional)

minLength1

List users with pagination

import Avara from 'avara';

const client = new Avara({
  apiKey: process.env['AVARA_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const userListResponse of client.viewer.users.list()) {
  console.log(userListResponse.middleName);
}

{
  "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"
}