Method: matters.holds.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists the holds in a matter.
HTTP request
GET https://vault.googleapis.com/v1/matters/{matterId}/holds
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
matterId |
string
The matter ID.
|
Query parameters
| Parameters |
pageSize |
integer
The number of holds to return in the response, between 0 and 100 inclusive. Leaving this empty, or as 0, is the same as pageSize = 100.
|
pageToken |
string
The pagination token as returned in the response. An empty token means start from the beginning.
|
view |
enum (HoldView)
The amount of detail to return for a hold.
|
Request body
The request body must be empty.
Response body
The holds for a matter.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"holds": [
{
object (Hold)
}
],
"nextPageToken": string
} |
| Fields |
holds[] |
object (Hold)
The list of holds.
|
nextPageToken |
string
Page token to retrieve the next page of results in the list. If this is empty, then there are no more holds to list.
|
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.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListHoldsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists the holds in a matter.\n\n### HTTP request\n\n`GET https://vault.googleapis.com/v1/matters/{matterId}/holds`\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\n### Query parameters\n\n| Parameters ||\n|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` The number of holds to return in the response, between 0 and 100 inclusive. Leaving this empty, or as 0, is the same as **pageSize** = 100. |\n| `pageToken` | `string` The pagination token as returned in the response. An empty token means start from the beginning. |\n| `view` | `enum (`[HoldView](/workspace/vault/reference/rest/v1/HoldView)`)` The amount of detail to return for a hold. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nThe holds for a matter.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------|\n| ``` { \"holds\": [ { object (/workspace/vault/reference/rest/v1/matters.holds#Hold) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|-------------------------------------------------------------------------------------------------------------------------------|\n| `holds[]` | `object (`[Hold](/workspace/vault/reference/rest/v1/matters.holds#Hold)`)` The list of holds. |\n| `nextPageToken` | `string` Page token to retrieve the next page of results in the list. If this is empty, then there are no more holds to list. |\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)."]]
