API Reference

Auto Scribe

Users

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

List users with pagination

GET/v1/autoScribe/users

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

Query ParametersExpand Collapse

canCreateReports: optional boolean

Filter by canCreateReports permission (AutoScribe-specific)

cursor: optional string

Base64 encoded cursor from previous response

email: optional string

Filter by exact email match

firstName: optional string

Filter by first name (contains match)

invitedSource: optional InvitedSource

Filter by invitation source

One of the following:

"dashboard"

"api"

lastName: optional string

Filter by last name (contains match)

level: optional UserLevel

Filter by user level

One of the following:

"owner"

"admin"

"member"

limit: optional number

Number of results to return (1-100)

minimum1

maximum100

ReturnsExpand Collapse

hasMore: boolean

users: array of object { canCreateReports, canManageStudies, clinicRole, 14 more }

canCreateReports: boolean

Whether the user can generate and sign radiology reports. Requires NPI number

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.

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

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’).

One of the following:

"dashboard"

"api"

lastLoginAt: string

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.

One of the following:

"owner"

"admin"

"member"

userId: string

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

middleName: optional string

User’s middle name (optional)

minLength1

npiNumber: optional string

National Provider Identifier - required for users who can create reports (10-digit number)

minLength10

maxLength10

phoneNumber: optional string

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

suffix1: optional string

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

minLength1

suffix2: optional string

Additional name suffix (optional)

minLength1

cursor: optional string

List users with pagination

HTTP

HTTP

TypeScript

Python

Java

C#

curl https://api.avarasoftware.com/v1/autoScribe/users \
    -H "Authorization: Bearer $AVARA_API_KEY"

200 example

{
  "hasMore": true,
  "users": [
    {
      "canCreateReports": true,
      "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",
      "npiNumber": "1234567893",
      "phoneNumber": "5551234567",
      "suffix1": "MD",
      "suffix2": "FACR"
    }
  ],
  "cursor": "cursor"
}

Returns Examples

200 example

{
  "hasMore": true,
  "users": [
    {
      "canCreateReports": true,
      "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",
      "npiNumber": "1234567893",
      "phoneNumber": "5551234567",
      "suffix1": "MD",
      "suffix2": "FACR"
    }
  ],
  "cursor": "cursor"
}