Create and invite a new user
Creates a new user in the AutoScribe system and sends them an invitation email. The user will have the specified permissions including report creation and study management capabilities. NPI number is required for users who can create reports.
Body Parameters
User's email address for login and notifications
User's first name
User's last name
User's middle name (optional)
User's phone number (10-15 digits, optional)
Name suffix (e.g., 'Jr.', 'Sr.', 'III') - optional
Additional name suffix (optional)
Returns
Whether the user can generate and sign radiology reports. Requires NPI number
Whether the user has permission to create, update, and manage studies
Timestamp when the user was created
User's email address for login and notifications
User's first name
Whether the user can access the dashboard interface. Required for admin users
Timestamp of user's last login, null if never logged in
User's last name
Unique user identifier. Format: usr_{32-hex-chars}
User's middle name (optional)
National Provider Identifier - required for users who can create reports (10-digit number)
User's phone number (10-15 digits, optional)
Name suffix (e.g., 'Jr.', 'Sr.', 'III') - optional
Additional name suffix (optional)
Create and invite a new user
curl https://api.avarasoftware.com/v1/autoScribe/users \
-H 'Content-Type: application/json' \
-H "Authorization: Bearer $AVARA_API_KEY" \
-d '{
"canCreateReports": true,
"canManageStudies": true,
"clinicRole": "Radiologist",
"email": "dr.johnson@hospital.org",
"firstName": "Sarah",
"hasDashboardAccess": true,
"lastName": "Johnson",
"level": "member",
"middleName": "Marie",
"npiNumber": "1234567893",
"phoneNumber": "5551234567",
"suffix1": "MD",
"suffix2": "FACR"
}'
{
"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"
}