Method: accessproposals.list

List the access proposals on a file. For more information, see Manage pending access proposals.

Note: Only approvers are able to list access proposals on a file. If the user isn't an approver, a 403 error is returned.

HTTP request

GET https://www.googleapis.com/drive/v3/files/{fileId}/accessproposals

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
fileId

string

Required. The ID of the item the request is on.

Query parameters

Parameters
pageToken

string

Optional. The continuation token on the list of access requests.
pageSize

integer

Optional. The number of results per page.

Request body

The request body must be empty.

Response body

The response to an access proposal list request.

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

JSON representation 
{
  "accessProposals": [
    {
      object (AccessProposal)
    }
  ],
  "nextPageToken": string
}
Fields
accessProposals[]

object (AccessProposal)

The list of access proposals. This field is only populated in Drive API v3.
nextPageToken

string

The continuation token for the next page of results. This will be absent if the end of the results list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/docs
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/drive.metadata
  • https://www.googleapis.com/auth/drive.metadata.readonly
  • https://www.googleapis.com/auth/drive.readonly

Some scopes are restricted and require a security assessment for your app to use them. For more information, see the Authorization guide.