Method: matters.holds.accounts.list
Lists the accounts covered by a hold. This can list only individually-specified accounts covered by the hold. If the hold covers an organizational unit, use the Admin SDK. to list the members of the organizational unit on hold.
HTTP request
GET https://vault.googleapis.com/v1/matters/{matterId}/holds/{holdId}/accounts
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
matterId |
string
The matter ID.
|
holdId |
string
The hold ID.
|
Request body
The request body must be empty.
Response body
Returns a list of the accounts covered by a hold.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"accounts": [
{
object (HeldAccount)
}
]
} |
| Fields |
accounts[] |
object (HeldAccount)
The held accounts on a hold.
|
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/ediscovery.readonlyhttps://www.googleapis.com/auth/ediscovery
For more information, see the OAuth 2.0 Overview.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-02-27 UTC.
[null,null,["Last updated 2025-02-27 UTC."],[[["Lists the accounts covered by a specified hold within a matter using the matter ID and hold ID."],["Returns information about the held accounts, but for organizational unit holds, the Admin SDK should be used."],["Requires specific authorization scopes for accessing and retrieving hold account data."],["Provides details on the HTTP request format, path parameters, request and response body structures."],["Includes a link to try the API functionality and further documentation on authorization."]]],["This document outlines the process to list accounts under a hold using an HTTP GET request. The request, directed to `https://vault.googleapis.com/v1/matters/{matterId}/holds/{holdId}/accounts`, requires `matterId` and `holdId` as path parameters. The request body must be empty. The successful response returns a JSON object containing an array of `accounts` which lists `HeldAccount` objects. Access requires either `ediscovery.readonly` or `ediscovery` OAuth scopes. Organizational units should use Admin SDK to get the list.\n"]]
