---
title: "GET /v1/matters/{matterId}/holds/{holdId}"
method: GET
path: "/v1/matters/{matterId}/holds/{holdId}"
tags: ["matters"]
---

# GET /v1/matters/{matterId}/holds/{holdId}

`GET /v1/matters/{matterId}/holds/{holdId}`

## Request

- Base URL: `https://vault.googleapis.com`
- URL: `https://vault.googleapis.com/v1/matters/{matterId}/holds/{holdId}`
- Auth: one of:
  - OAuth 2 and OAuth 2
    - Implicit: `https://accounts.google.com/o/oauth2/auth`
    - Scopes: `https://www.googleapis.com/auth/ediscovery`
    - Authorization code: `https://accounts.google.com/o/oauth2/auth`
    - Token URL: `https://accounts.google.com/o/oauth2/token` scopes: `https://www.googleapis.com/auth/ediscovery`
  - OAuth 2 and OAuth 2
    - Implicit: `https://accounts.google.com/o/oauth2/auth`
    - Scopes: `https://www.googleapis.com/auth/ediscovery.readonly`
    - Authorization code: `https://accounts.google.com/o/oauth2/auth`
    - Token URL: `https://accounts.google.com/o/oauth2/token` scopes: `https://www.googleapis.com/auth/ediscovery.readonly`
- TypeScript: <https://skmtc.dev/google/apis/vault/docs/v1/matters/:matterId/holds/:holdId/get.ts> (a function with typed inputs; its response is checked against the schema)

Gets the specified hold.

## Path parameters

- `matterId` string, required
- `holdId` string, required

## Query parameters

- `view` 'HOLD_VIEW_UNSPECIFIED' | 'BASIC_HOLD' | 'FULL_HOLD'

## Response `200`

Successful response

- Hold: A hold. A hold prevents the specified Google Workspace service from purging data for specific accounts or all members of an organizational unit. To work with Vault resources, the account must have the [required Vault privileges] (https://support.google.com/vault/answer/2799699) and access to the matter. To access a matter, the account must have created the matter, have the matter shared with them, or have the **View All Matters** privilege.
  - `accounts` HeldAccount[]: If set, the hold applies to the specified accounts and **orgUnit** must be empty.
    - `accountId` string: The account ID, as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
    - `email` string: The primary email address of the account. If used as an input, this takes precedence over **accountId**.
    - `firstName` string: Output only. The first name of the account holder.
    - `holdTime` string, google-datetime: Output only. When the account was put on hold.
    - `lastName` string: Output only. The last name of the account holder.
  - `corpus` 'CORPUS_TYPE_UNSPECIFIED' | 'DRIVE' | 'MAIL' | 'GROUPS' | 'HANGOUTS_CHAT' | 'VOICE' | 'CALENDAR' | 'GEMINI' | 'GEMINI_IN_WORKSPACE': The service to be searched.
  - `holdId` string: The unique immutable ID of the hold. Assigned during creation.
  - `name` string: The name of the hold.
  - `orgUnit` HeldOrgUnit: The organizational unit covered by a hold. This structure is immutable.
    - `holdTime` string, google-datetime: When the organizational unit was put on hold. This property is immutable.
    - `orgUnitId` string: The organizational unit's immutable ID as provided by the [Admin SDK](https://developers.google.com/admin-sdk/).
  - `query` CorpusQuery: Service-specific options for holds.
    - `calendarQuery` HeldCalendarQuery: Options for Calendar holds.
    - `driveQuery` HeldDriveQuery: Options for Drive holds.
      - `includeSharedDriveFiles` boolean: To include files in shared drives in the hold, set to **true**.
      - `includeTeamDriveFiles` boolean: To include files in Team Drives in the hold, set to **true**.
    - `geminiQuery` HeldGeminiQuery: Options for Gemini app holds.
    - `groupsQuery` HeldGroupsQuery: Query options for group holds.
      - `endTime` string, google-datetime: The end time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
      - `startTime` string, google-datetime: The start time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
      - `terms` string: The [search operators](https://support.google.com/vault/answer/2474474) used to refine the messages covered by the hold.
    - `hangoutsChatQuery` HeldHangoutsChatQuery: Options for Chat holds.
      - `includeRooms` boolean: To include messages in Chat spaces the user was a member of, set to **true**.
    - `mailQuery` HeldMailQuery: Query options for Gmail holds.
      - `endTime` string, google-datetime: The end time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
      - `startTime` string, google-datetime: The start time for the query. Specify in GMT. The value is rounded to 12 AM on the specified date.
      - `terms` string: The [search operators](https://support.google.com/vault/answer/2474474) used to refine the messages covered by the hold.
    - `voiceQuery` HeldVoiceQuery: Options for Voice holds.
      - `coveredData` string[]: A list of data types covered by the hold. Should be non-empty. Order does not matter and duplicates are ignored.
  - `updateTime` string, google-datetime: The last time this hold was modified.

## Changes

- **2026-10-28** `61f77024dfb4`: 4 info
  - the security scope `https://www.googleapis.com/auth/ediscovery` was added to the endpoint's security scheme `Oauth2`
  - the security scope `https://www.googleapis.com/auth/ediscovery` was added to the endpoint's security scheme `Oauth2c`
  - the security scope `https://www.googleapis.com/auth/ediscovery.readonly` was removed from the endpoint's security scheme `Oauth2`
  - the security scope `https://www.googleapis.com/auth/ediscovery.readonly` was removed from the endpoint's security scheme `Oauth2c`
- **2026-10-10** `ddd37fff1925`: 1 breaking, 4 info
  - removed the media type `*/*` for the response with the status `200`
  - the security scope `https://www.googleapis.com/auth/ediscovery` was added to the endpoint's security scheme `Oauth2`
  - the security scope `https://www.googleapis.com/auth/ediscovery` was added to the endpoint's security scheme `Oauth2c`
  - the security scope `https://www.googleapis.com/auth/ediscovery.readonly` was removed from the endpoint's security scheme `Oauth2`
  - …1 more
- …earlier changes not shown

[Operation history](https://skmtc.dev/google/apis/vault/changes/v1/matters/:matterId/holds/:holdId/get.md)

---

[API](https://skmtc.dev/google/apis/vault.md) - [All operations](https://skmtc.dev/google/apis/vault/llms.txt) - [OpenAPI document](https://skmtc.dev/google/apis/vault/revisions/726c68a20360?raw)