Retrieve a user by ID

get/v1/autoScribe/users/{userId}

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

Path ParametersExpand Collapse

userId: string

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

ReturnsExpand Collapse

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: "Radiologist" or "Cardiologist" or "Neurologist" or 18 more

User's clinical or organizational role

Accepts one of the following:

"Radiologist"

"Cardiologist"

"Neurologist"

"Urologist"

"Gynecologist"

"Endocrinologist"

"Doctor"

"Surgeon"

"Physician"

"Physician Assistant"

"Nurse Practitioner"

"Registered Nurse"

"Patient Care Coordinator"

"Front Desk Operator"

"Imaging Technologist"

"PACS Administrator"

"Software Engineer"

"Revenue Cycle Manager"

"Administrative Director"

"Administrative Assistant"

"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: "dashboard" or "api"

How the user was invited - via dashboard UI or API

Accepts 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: "owner" or "admin" or "member"

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

Retrieve a user by ID

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

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

Returns Examples

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