List user invitations

get/v1/viewer/users/invitations

Retrieves a paginated list of user invitations with optional filtering by status, expiration, date range, and user ID. Returns up to 100 invitations per request.

Query ParametersExpand Collapse

cursor: optional string

Base64 encoded cursor from previous response

endDate: optional string

Filter invitations created on or before this date (YYYY-MM-DD)

expired: optional "all" or "expired" or "not-expired"

Filter by expiration status

Accepts one of the following:

"all"

"expired"

"not-expired"

limit: optional number

Number of results to return (1-100)

minimum1

maximum100

startDate: optional string

Filter invitations created on or after this date (YYYY-MM-DD)

status: optional array of "sent" or "accepted" or "rejected" or "revoked"

Filter by invitation status(es)

Accepts one of the following:

"sent"

"accepted"

"rejected"

"revoked"

userId: optional string

Filter by user ID. Format: usr_{32-hex-chars}

ReturnsExpand Collapse

hasMore: boolean

invitations: array of object { canManageStudies, clinicId, clinicRole, 18 more }

canManageStudies: boolean

Whether the invited user will have permission to manage studies

clinicId: string

UUID of the clinic this invitation belongs to

formatuuid

clinicRole: "Radiologist" or "Cardiologist" or "Neurologist" or 18 more

Clinical or organizational role for the invited user

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 invitation was created

formatdate-time

email: string

Email address the invitation was sent to

expiry: string

When the invitation expires, null if no expiration

formatdate-time

firstName: string

Invited user's first name

minLength1

hasDashboardAccess: boolean

Whether the invited user will have dashboard access

invitationId: string

Unique invitation identifier. Format: inv_{32-hex-chars}

invitedSource: "dashboard" or "api"

How the invitation was created - 'dashboard' or 'api'

Accepts one of the following:

"dashboard"

"api"

inviterId: string

User ID of the person who sent the invitation. Format: usr_{32-hex-chars}. Null if invited via API

lastName: string

Invited user's last name

minLength1

level: "owner" or "admin" or "member"

Access level for the invited user. 'admin' or 'member' when created via API

Accepts one of the following:

"owner"

"admin"

"member"

status: "sent" or "accepted" or "rejected" or "revoked"

Invitation status: 'sent', 'accepted', 'rejected', or 'revoked'

Accepts one of the following:

"sent"

"accepted"

"rejected"

"revoked"

updatedAt: string

Timestamp when the invitation was last updated

formatdate-time

userId: string

Pre-generated user ID for this invitation. Format: usr_{32-hex-chars}. This ID is assigned at invitation creation and will become the user's permanent ID upon acceptance

invitedByApiKeyId: optional string

UUID of the API key used to send this invitation. Null if sent via dashboard

formatuuid

middleName: optional string

Invited user's middle name (optional)

minLength1

phoneNumber: optional string

Invited user's phone number (optional)

suffix1: optional string

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

minLength1

suffix2: optional string

Additional name suffix - optional

minLength1

cursor: optional string

List user invitations

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

{
  "hasMore": true,
  "invitations": [
    {
      "canManageStudies": true,
      "clinicId": "550e8400-e29b-41d4-a716-446655440000",
      "clinicRole": "Radiologist",
      "createdAt": "2024-03-15T10:00:00Z",
      "email": "dr.chen@hospital.org",
      "expiry": "2024-04-15T00:00:00Z",
      "firstName": "Michael",
      "hasDashboardAccess": true,
      "invitationId": "inv_1234567890abcdef1234567890abcdef",
      "invitedSource": "api",
      "inviterId": "usr_1234567890abcdef1234567890abcdef",
      "lastName": "Chen",
      "level": "member",
      "status": "sent",
      "updatedAt": "2024-03-15T10:00:00Z",
      "userId": "usr_1234567890abcdef1234567890abcdef",
      "invitedByApiKeyId": "550e8400-e29b-41d4-a716-446655440000",
      "middleName": "David",
      "phoneNumber": "5551234567",
      "suffix1": "MD",
      "suffix2": null
    }
  ],
  "cursor": "cursor"
}

Returns Examples

{
  "hasMore": true,
  "invitations": [
    {
      "canManageStudies": true,
      "clinicId": "550e8400-e29b-41d4-a716-446655440000",
      "clinicRole": "Radiologist",
      "createdAt": "2024-03-15T10:00:00Z",
      "email": "dr.chen@hospital.org",
      "expiry": "2024-04-15T00:00:00Z",
      "firstName": "Michael",
      "hasDashboardAccess": true,
      "invitationId": "inv_1234567890abcdef1234567890abcdef",
      "invitedSource": "api",
      "inviterId": "usr_1234567890abcdef1234567890abcdef",
      "lastName": "Chen",
      "level": "member",
      "status": "sent",
      "updatedAt": "2024-03-15T10:00:00Z",
      "userId": "usr_1234567890abcdef1234567890abcdef",
      "invitedByApiKeyId": "550e8400-e29b-41d4-a716-446655440000",
      "middleName": "David",
      "phoneNumber": "5551234567",
      "suffix1": "MD",
      "suffix2": null
    }
  ],
  "cursor": "cursor"
}