Google Vault

Google Vault Holds API

The Holds API from Google Vault — 4 operation(s) for holds.

GitHub OpenAPI
Business capability
Litigation & Dispute Management BC-150.20

Operations 7

GET /v1/matters/{matterId}/holds List holds #
POST /v1/matters/{matterId}/holds Create hold #
GET /v1/matters/{matterId}/holds/{holdId} Get hold #
PUT /v1/matters/{matterId}/holds/{holdId} Update hold #
DELETE /v1/matters/{matterId}/holds/{holdId} Delete hold #
POST /v1/matters/{matterId}/holds/{holdId}:addHeldAccounts Bulk add held accounts #
POST /v1/matters/{matterId}/holds/{holdId}:removeHeldAccounts Bulk remove held accounts #

Documentation

📖
APIReference
https://developers.google.com/workspace/vault/reference/rest
📖
Documentation
https://developers.google.com/workspace/vault/reference/rest
📖
Authentication
https://developers.google.com/workspace/vault/auth

Specifications

⚙
OpenAPI
https://artifacts.apis.io/google-vault/openapi/google-vault-holds-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/google-vault/json-schema/google-vault-hold-schema.json

Other Resources

🔗
Overlay
https://artifacts.apis.io/google-vault/overlays/google-vault-holds-api-overlay.yaml
🔗
Pricing
https://workspace.google.com/pricing.html
🔗
TermsOfService
https://developers.google.com/terms

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/google-vault:google-vault-holds-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

google-vault-holds-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Google Vault Holds API
  description: Best-effort OpenAPI 3.1 for the Google Vault API, an information governance and eDiscovery API for Google Workspace. Covers matters, holds, exports, saved queries, held accounts, and long-running operations.
  version: v1
servers:
- url: https://vault.googleapis.com
security:
- googleOAuth: []
tags:
- name: Holds
paths:
  /v1/matters/{matterId}/holds:
    get:
      tags:
      - Holds
      summary: List holds
      operationId: matters.holds.list
      parameters:
      - in: path
        name: matterId
        required: true
        schema:
          type: string
      - in: query
        name: view
        schema:
          type: string
          enum:
          - HOLD_VIEW_UNSPECIFIED
          - BASIC_HOLD
          - FULL_HOLD
      responses:
        '200':
          description: Holds
    post:
      tags:
      - Holds
      summary: Create hold
      operationId: matters.holds.create
      parameters:
      - in: path
        name: matterId
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Hold'
      responses:
        '200':
          description: Hold
  /v1/matters/{matterId}/holds/{holdId}:
    get:
      tags:
      - Holds
      summary: Get hold
      operationId: matters.holds.get
      parameters:
      - in: path
        name: matterId
        required: true
        schema:
          type: string
      - in: path
        name: holdId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Hold
    put:
      tags:
      - Holds
      summary: Update hold
      operationId: matters.holds.update
      parameters:
      - in: path
        name: matterId
        required: true
        schema:
          type: string
      - in: path
        name: holdId
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Hold'
      responses:
        '200':
          description: Hold
    delete:
      tags:
      - Holds
      summary: Delete hold
      operationId: matters.holds.delete
      parameters:
      - in: path
        name: matterId
        required: true
        schema:
          type: string
      - in: path
        name: holdId
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Empty
  /v1/matters/{matterId}/holds/{holdId}:addHeldAccounts:
    post:
      tags:
      - Holds
      summary: Bulk add held accounts
      operationId: matters.holds.addHeldAccounts
      parameters:
      - in: path
        name: matterId
        required: true
        schema:
          type: string
      - in: path
        name: holdId
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                emails:
                  type: array
                  items:
                    type: string
                accountIds:
                  type: array
                  items:
                    type: string
      responses:
        '200':
          description: Result
  /v1/matters/{matterId}/holds/{holdId}:removeHeldAccounts:
    post:
      tags:
      - Holds
      summary: Bulk remove held accounts
      operationId: matters.holds.removeHeldAccounts
      parameters:
      - in: path
        name: matterId
        required: true
        schema:
          type: string
      - in: path
        name: holdId
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                accountIds:
                  type: array
                  items:
                    type: string
      responses:
        '200':
          description: Result
components:
  schemas:
    Hold:
      type: object
      properties:
        holdId:
          type: string
        name:
          type: string
        corpus:
          type: string
          enum:
          - CORPUS_TYPE_UNSPECIFIED
          - DRIVE
          - MAIL
          - GROUPS
          - HANGOUTS_CHAT
          - VOICE
          - CALENDAR
        query:
          type: object
        accounts:
          type: array
          items:
            type: object
            properties:
              accountId:
                type: string
              email:
                type: string
        orgUnit:
          type: object
          properties:
            orgUnitId:
              type: string
            holdTime:
              type: string
              format: date-time
        updateTime:
          type: string
          format: date-time
  securitySchemes:
    googleOAuth:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://accounts.google.com/o/oauth2/v2/auth
          tokenUrl: https://oauth2.googleapis.com/token
          scopes:
            https://www.googleapis.com/auth/ediscovery: Manage all Vault data
            https://www.googleapis.com/auth/ediscovery.readonly: Read-only Vault data