Method: matters.holds.accounts.list
Stay organized with collections
Save and categorize content based on your preferences.
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 Authorization guide.
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-03-17 UTC.
[null,null,["Last updated 2025-03-17 UTC."],[],[],null,["# Method: matters.holds.accounts.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListHeldAccountsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists 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](https://developers.google.com/admin-sdk/). to list the members of the organizational unit on hold.\n\n### HTTP request\n\n`GET https://vault.googleapis.com/v1/matters/{matterId}/holds/{holdId}/accounts`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|------------|-------------------------|\n| `matterId` | `string` The matter ID. |\n| `holdId` | `string` The hold ID. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nReturns a list of the accounts covered by a hold.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------|\n| ``` { \"accounts\": [ { object (/workspace/vault/reference/rest/v1/matters.holds.accounts#HeldAccount) } ] } ``` |\n\n| Fields ||\n|--------------|--------------------------------------------------------------------------------------------------------------------------------|\n| `accounts[]` | `object (`[HeldAccount](/workspace/vault/reference/rest/v1/matters.holds.accounts#HeldAccount)`)` The held accounts on a hold. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/ediscovery.readonly`\n- `https://www.googleapis.com/auth/ediscovery`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
