## Retrieve By Uid

`StudyRetrieveByUidResponse Viewer.Studies.RetrieveByUid(StudyRetrieveByUidParamsparameters, CancellationTokencancellationToken = default)`

**get** `/v1/viewer/studies/by-uid/{studyInstanceUid}`

Retrieves a single study by its DICOM Study Instance UID. This is useful when you have the DICOM UID but not the Avara study ID.

### Parameters

- `StudyRetrieveByUidParams parameters`

  - `required string studyInstanceUid`

    DICOM Study Instance UID. Format: numbers and dots (e.g., 1.2.840.10008.5.1.4.1.1.2).

### Returns

- `class StudyRetrieveByUidResponse:`

  A study entity in the Viewer system with viewing status

  - `required DateTimeOffset? CancelledAt`

    Timestamp when the study was cancelled, null if not cancelled

  - `required DateTimeOffset? CreatedAt`

    Timestamp when the study was created

  - `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

    - `"normal"Normal`

    - `"high"High`

    - `"stat"Stat`

  - `required string StudyDescription`

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

  - `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')

  - `required StudyViewerStatus StudyViewerStatus`

    - `"incomplete"Incomplete`

    - `"complete"Complete`

  - `required DateTimeOffset? UpdatedAt`

    Timestamp when the study was last updated

  - `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)

    - `required string Description`

      Human-readable description of the API key

    - `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

  - `IReadOnlyDictionary<string, string> Metadata`

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

### Example

```csharp
StudyRetrieveByUidParams parameters = new()
{
    StudyInstanceUid = "1.2.840.10008.5.1.4.1.1.2"
};

var response = await client.Viewer.Studies.RetrieveByUid(parameters);

Console.WriteLine(response);
```