List studies with pagination

StudyListPageResponse Viewer.Studies.List(, )

GET/v1/viewer/studies

Retrieves a paginated list of studies with optional filtering by assignment, severity, description, cancellation status, and viewer status. Returns up to 100 studies per request.

ParametersExpand Collapse

StudyListParams parameters

string? assignedTo

Filter by assigned user ID (null = explicitly unassigned). Format: usr_<32-hex-chars>

string cursor

Base64 encoded cursor from previous response

string? expressCustomerID

Filter by Express customer ID (null = studies with no customer). Format: cus_{32-hex-chars}

Boolean? isCancelled

Filter by cancellation status

Double limit

Number of results to return (1-100)

minimum1

maximum100

Severity severity

Filter by study severity

string studyDescription

Filter by study description (contains match)

StudyViewerStatus studyViewerStatus

Filter by study viewer status

ReturnsExpand Collapse

class StudyListPageResponse:

Paginated list of Viewer studies

required Boolean HasMore

required IReadOnlyList<StudyListResponse> Studies

required DateTimeOffset? CancelledAt

Timestamp when the study was cancelled, null if not cancelled

formatdate-time

required DateTimeOffset? CreatedAt

Timestamp when the study was created

formatdate-time

required Boolean IsCancelled

Whether the study has been cancelled

required Severity Severity

Priority level of the study. 'normal' for routine, 'high' for urgent, 'stat' for immediate attention

Accepts one of the following:

required string StudyDescription

Description of the study/scan (e.g., 'Brain MRI with Contrast', 'Chest CT')

minLength1

required string StudyID

Unique study identifier. Format: stu_{32-hex-chars}

required string StudyInstanceUid

DICOM Study Instance UID. Must be a valid DICOM UID format (e.g., '1.2.840.10008.5.1.4.1.1.2')

minLength1

required StudyViewerStatus StudyViewerStatus

Accepts one of the following:

required DateTimeOffset? UpdatedAt

Timestamp when the study was last updated

formatdate-time

UserReference? AssignedTo

A reference to a user with basic identifying information

required string Email

User's email address

required string UserID

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

string FirstName

User's first name

string LastName

User's last name

string MiddleName

User's middle name

string Suffix1

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

string Suffix2

Additional name suffix

ApiKeyReference? CreatedByApiKey

A reference to an API key with basic identifying information

required string ApiKeyID

Unique API key identifier (UUIDv4 format)

formatuuid

required string Description

Human-readable description of the API key

minLength1

Boolean IsViewerEnabled

Whether this API key has access to the Viewer product

UserReference? CreatedByUser

A reference to a user with basic identifying information

required string Email

User's email address

required string UserID

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

string FirstName

User's first name

string LastName

User's last name

string MiddleName

User's middle name

string Suffix1

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

string Suffix2

Additional name suffix

ExpressCustomerReference? ExpressCustomer

A reference to an Express customer with basic identifying information

required string ExpressCustomerID

Unique Express customer identifier. Format: cus_{32-hex-chars}

required string ExpressCustomerName

Name of the Express customer

minLength1

IReadOnlyDictionary<string, string> Metadata

Custom key-value metadata for the study. Maximum 50 pairs, keys up to 100 chars, values up to 1000 chars

string Cursor

List studies with pagination

StudyListParams parameters = new();

var page = await client.Viewer.Studies.List(parameters);
await foreach (var item in page.Paginate())
{
    Console.WriteLine(item);
}

{
  "hasMore": true,
  "studies": [
    {
      "cancelledAt": null,
      "createdAt": "2024-03-15T10:30:00Z",
      "isCancelled": false,
      "severity": "high",
      "studyDescription": "CT Chest/Abdomen/Pelvis",
      "studyId": "stu_1234567890abcdef1234567890abcdef",
      "studyInstanceUid": "1.2.840.113619.2.55.3.604688119.868.1234567890.123",
      "studyViewerStatus": "incomplete",
      "updatedAt": "2024-03-15T14:20:00Z",
      "assignedTo": {
        "email": "dr.smith@radiology.com",
        "userId": "usr_1234567890abcdef1234567890abcdef",
        "firstName": "John",
        "lastName": "Smith",
        "middleName": "Robert",
        "suffix1": "MD",
        "suffix2": "FACR"
      },
      "createdByApiKey": {
        "apiKeyId": "550e8400-e29b-41d4-a716-446655440000",
        "description": "Production API Key",
        "isViewerEnabled": true
      },
      "createdByUser": {
        "email": "dr.smith@radiology.com",
        "userId": "usr_1234567890abcdef1234567890abcdef",
        "firstName": "John",
        "lastName": "Smith",
        "middleName": "Robert",
        "suffix1": "MD",
        "suffix2": "FACR"
      },
      "expressCustomer": {
        "expressCustomerId": "cus_1234567890abcdef1234567890abcdef",
        "expressCustomerName": "City Medical Center"
      },
      "metadata": {
        "department": "radiology",
        "priority": "urgent"
      }
    }
  ],
  "cursor": "cursor"
}

Returns Examples

{
  "hasMore": true,
  "studies": [
    {
      "cancelledAt": null,
      "createdAt": "2024-03-15T10:30:00Z",
      "isCancelled": false,
      "severity": "high",
      "studyDescription": "CT Chest/Abdomen/Pelvis",
      "studyId": "stu_1234567890abcdef1234567890abcdef",
      "studyInstanceUid": "1.2.840.113619.2.55.3.604688119.868.1234567890.123",
      "studyViewerStatus": "incomplete",
      "updatedAt": "2024-03-15T14:20:00Z",
      "assignedTo": {
        "email": "dr.smith@radiology.com",
        "userId": "usr_1234567890abcdef1234567890abcdef",
        "firstName": "John",
        "lastName": "Smith",
        "middleName": "Robert",
        "suffix1": "MD",
        "suffix2": "FACR"
      },
      "createdByApiKey": {
        "apiKeyId": "550e8400-e29b-41d4-a716-446655440000",
        "description": "Production API Key",
        "isViewerEnabled": true
      },
      "createdByUser": {
        "email": "dr.smith@radiology.com",
        "userId": "usr_1234567890abcdef1234567890abcdef",
        "firstName": "John",
        "lastName": "Smith",
        "middleName": "Robert",
        "suffix1": "MD",
        "suffix2": "FACR"
      },
      "expressCustomer": {
        "expressCustomerId": "cus_1234567890abcdef1234567890abcdef",
        "expressCustomerName": "City Medical Center"
      },
      "metadata": {
        "department": "radiology",
        "priority": "urgent"
      }
    }
  ],
  "cursor": "cursor"
}