Method: matters.holds.list

Lists holds within a matter. An empty page token in ListHoldsResponse denotes no more holds to list.

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

number

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)

Specifies which parts of the Hold to return.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

The holds for a matter.

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.readonly
  • https://www.googleapis.com/auth/ediscovery

Try it!