## Retrieve By Uid

`viewer.studies.retrieve_by_uid(strstudy_instance_uid)  -> StudyRetrieveByUidResponse`

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

- `study_instance_uid: str`

  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

  - `cancelled_at: Optional[datetime]`

    Timestamp when the study was cancelled, null if not cancelled

  - `created_at: Optional[datetime]`

    Timestamp when the study was created

  - `is_cancelled: bool`

    Whether the study has been cancelled

  - `severity: Literal["normal", "high", "stat"]`

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

    - `"normal"`

    - `"high"`

    - `"stat"`

  - `study_description: str`

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

  - `study_id: str`

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

  - `study_instance_uid: str`

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

  - `study_viewer_status: Literal["incomplete", "complete"]`

    - `"incomplete"`

    - `"complete"`

  - `updated_at: Optional[datetime]`

    Timestamp when the study was last updated

  - `assigned_to: Optional[UserReference]`

    A reference to a user with basic identifying information

    - `email: str`

      User's email address

    - `user_id: str`

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

    - `first_name: Optional[str]`

      User's first name

    - `last_name: Optional[str]`

      User's last name

    - `middle_name: Optional[str]`

      User's middle name

    - `suffix1: Optional[str]`

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

    - `suffix2: Optional[str]`

      Additional name suffix

  - `created_by_api_key: Optional[APIKeyReference]`

    A reference to an API key with basic identifying information

    - `api_key_id: str`

      Unique API key identifier (UUIDv4 format)

    - `description: str`

      Human-readable description of the API key

    - `is_viewer_enabled: Optional[bool]`

      Whether this API key has access to the Viewer product

  - `created_by_user: Optional[UserReference]`

    A reference to a user with basic identifying information

    - `email: str`

      User's email address

    - `user_id: str`

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

    - `first_name: Optional[str]`

      User's first name

    - `last_name: Optional[str]`

      User's last name

    - `middle_name: Optional[str]`

      User's middle name

    - `suffix1: Optional[str]`

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

    - `suffix2: Optional[str]`

      Additional name suffix

  - `express_customer: Optional[ExpressCustomerReference]`

    A reference to an Express customer with basic identifying information

    - `express_customer_id: str`

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

    - `express_customer_name: str`

      Name of the Express customer

  - `metadata: Optional[Dict[str, str]]`

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

### Example

```python
import os
from avara import Avara

client = Avara(
    api_key=os.environ.get("AVARA_API_KEY"),  # This is the default and can be omitted
)
response = client.viewer.studies.retrieve_by_uid(
    "1.2.840.10008.5.1.4.1.1.2",
)
print(response.study_instance_uid)
```