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

# Lists the users of a Legal Hold policy - v4

`GET /legalholds/v4/policies/{policyId}/users`

## Request

- Base URL: `https://apis.druva.com/insync`
- URL: `https://apis.druva.com/insync/legalholds/v4/policies/{policyId}/users`
- Auth: API key in header `Authorization`

Returns the list of users who are a part of Legal Hold.

## Path parameters

- `policyId` integer, required

## Query parameters

- `pageNumber` integer
- `pageSize` integer
- `searchPrefix` string
- `sortBy` 'name'
- `sortOrder` 'asc' | 'desc'

## Response `200`

OK

- ViewLegalHoldPolicyCustodians
  - `results` ViewLegalHoldPolicyCustodiansResponse
    - `usersList` object[]
      - `userName` string: Name of the user who is on Legal Hold. Example - John Doe
      - `status` 'Active' | 'Inactive': The status of the user. It can be either Active or Inactive.
      - `userEmail` string: User email ID who is on Legal Hold. Example - john@druva.org
      - `collectedData` string: Size of the data collected in the last backup snapshot. Example - 1.68 GB
      - `collectedDataInBytes` integer: Size of the data (in bytes) collected in the last backup snapshot. Example - 1800010372
      - `userId` integer: Unique ID of the user. Example - 3
      - `policyId` integer: Unique ID of the Legal Hold policy to which the user belongs. Example - 12529
      - `onLegalHold` boolean: Flag to indicate if user is on Legal Hold or not. Example - true/false
      - `numberOfDataSources` integer: Number of data sources for current User. Example - 2
      - `totalCollectedData` string: Total data collected. Example - 2.12 GB
      - `totalCollectedDataInBytes` integer: Total data collected in bytes. Example - 2276332666
    - `totalCustodians` integer: Number of custodians in a Legal Hold policy. Example- 1
  - `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
- `403`: Access denied: Insufficient permissions. User requires specific access rights and minimum permissions. Details: https://help.druva.com/en/articles/15069296
- `404`: Not found
- `422`: Unprocessable Entity
- `500`: Internal Server Error

---

[API](https://skmtc.dev/druva/apis/insync-cloud.md) - [All operations](https://skmtc.dev/druva/apis/insync-cloud/llms.txt) - [OpenAPI document](https://skmtc.dev/druva/apis/insync-cloud/revisions/a0ce6d05033c?raw)