GOgoogle
matters

GET /v1/matters/{matterId}/holds

Changed on

Lists the holds in a matter.

Request

  • Base URL
    https://vault.googleapis.com
  • Auth
    • OAuth 2 and OAuth 2
      Implicithttps://accounts.google.com/o/oauth2/auth
      Scopeshttps://www.googleapis.com/auth/ediscovery
      Authorization codehttps://accounts.google.com/o/oauth2/auth
      Token URLhttps://accounts.google.com/o/oauth2/token
      Scopeshttps://www.googleapis.com/auth/ediscovery
    • or OAuth 2 and OAuth 2
      Implicithttps://accounts.google.com/o/oauth2/auth
      Scopeshttps://www.googleapis.com/auth/ediscovery.readonly
      Authorization codehttps://accounts.google.com/o/oauth2/auth
      Token URLhttps://accounts.google.com/o/oauth2/token
      Scopeshttps://www.googleapis.com/auth/ediscovery.readonly
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

matterIdstring required

The matter ID.

Query parameters

pageSizeinteger

The number of holds to return in the response, between 0 and 100 inclusive. Leaving this empty, or as 0, is the same as page_size = 100.

pageTokenstring

The pagination token as returned in the response. An empty token means start from the beginning.

view'HOLD_VIEW_UNSPECIFIED' | 'BASIC_HOLD' | 'FULL_HOLD'

The amount of detail to return for a hold.

Response

Successful response

nextPageTokenstring

Page token to retrieve the next page of results in the list. If this is empty, then there are no more holds to list.

Changes

  • 61f77024dfb4Revision changes
    • info

      the security scope https://www.googleapis.com/auth/ediscovery was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/ediscovery was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/ediscovery.readonly was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/ediscovery.readonly was removed from the endpoint's security scheme Oauth2c

  • ddd37fff1925Revision changes
    • breaking

      removed the media type */* for the response with the status

    • info

      the security scope https://www.googleapis.com/auth/ediscovery was added to the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/ediscovery was added to the endpoint's security scheme Oauth2c

    • info

      the security scope https://www.googleapis.com/auth/ediscovery.readonly was removed from the endpoint's security scheme Oauth2

    • info

      the security scope https://www.googleapis.com/auth/ediscovery.readonly was removed from the endpoint's security scheme Oauth2c