---
title: "Lists all the devices of a Legal Hold policy - v4"
method: GET
path: "/legalholds/v4/policies/{policyId}/collection-stream"
tags: ["Legal Hold"]
---

# Lists all the devices of a Legal Hold policy - v4

`GET /legalholds/v4/policies/{policyId}/collection-stream`

Returns the list of all Legal Hold devices.

## Path parameters

- `policyId` integer, required

## Query parameters

- `pageNumber` integer
- `pageSize` integer
- `searchString` string
- `collectionType` 'Backup' | 'Additional'
- `collectionStatus` 'Successful' | 'Failed' | 'Collected with Errors' | 'Never Collected' | 'Collection Throttled' | 'Inactive'
- `sortBy` 'custodianName' | 'deviceName' | 'totalCollectedData' | 'lastCompletedCollection' | 'deviceStatus'
- `sortOrder` 'asc' | 'desc'

## Response `200`

OK

- ViewLegalHoldPolicyCollectionStream
  - `results` ViewLegalHoldPolicyCollectionStreamResponse
    - `streamsList` object[]
      - `deviceName` string — Name of the device that is on Legal Hold. Example - Desktop1-john
      - `collectionType` 'Backup' | 'Additional' — The type of the device. It can be either Backup or Additional.
      - `collectionStatus` 'Successful' | 'Failed' | 'Collected with Errors' | 'Never Collected' | 'Collection Throttled' | 'Inactive' — Collection status of a device on Legal Hold. Example - Successful
      - `totalCollectedDataInBytes` integer — Size of the total data (in bytes) collected. Example - 1800010372
      - `linkId` integer — For device type 'Additional', this is the ID of the linked backup device. Example - 10008179
      - `custodianName` string — Name of the custodian on Legal Hold. Example - John Doe
      - `platformIcon` string — Name of the device platform image. Example - windows.png
      - `deviceStatus` string — Status of the device. Example - Enabled
      - `isCollectionDisabled` boolean — Flag to indicate if collection on Legal Hold is disabled or not. Example - false
      - `isCloudApp` boolean — Flag to indicate if the device on Legal Hold is of type Cloud Apps. Example - false
      - `custodianId` integer — Unique ID of the custodian. Example - 10005623
      - `deviceId` integer — Unique ID of the device. Example - 10008211
      - `lastCompletedCollection` string — Timestamp of last completed collection for a device. Example - Sep 05 2024, 02:55
      - `platformName` string — Name of the device platform. Example - win32
      - `totalCollectedData` string — Total data collected. Example - 2.12 GB
    - `totalResults` integer — Number of devices in a given Legal Hold policy. Example- 4
  - `pageInfo` PageInfo
    - `totalPages` integer — Total number of pages for the API Response. Example - 1
    - `pageNumber` integer — Page number for which API response is expected. Example - 1
    - `pageSize` integer — Page Size for API response. Example - 100

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `404` — Not found
- `422` — Unprocessable Entity
- `500` — Internal Server Error

---

[API](https://skmtc.net/druva/apis/authentication.md) · [All operations](https://skmtc.net/druva/apis/authentication/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/druva/authentication/revisions/2af2bf148b25/schema)