Method: files.accessproposals.list

List the AccessProposals on a file. Note: Only approvers are able to list AccessProposals on a file. If the user is not an approver, returns a 403.

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 v3 and v3beta.
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.

AccessProposal

The Access Proposal resource for outstanding access proposals on a file

JSON representation 
{
  "fileId": string,
  "proposalId": string,
  "requesterEmailAddress": string,
  "recipientEmailAddress": string,
  "rolesAndViews": [
    {
      object (RoleAndView)
    }
  ],
  "requestMessage": string,
  "createTime": string
}
Fields
fileId

string

The file id that the proposal for access is on
proposalId

string

The id of the access proposal
requesterEmailAddress

string

The email address of the requesting user
recipientEmailAddress

string

The email address of the user that will receive permissions if accepted
rolesAndViews[]

object (RoleAndView)

A wrapper for the role and view of an access proposal.
requestMessage

string

The message that the requester added to the proposal
createTime

string (Timestamp format)

The creation time

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

RoleAndView

A wrapper for the role and view of an access proposal.

JSON representation 
{
  "role": string,
  "view": string
}
Fields
role

string

The role that was proposed by the requester New values may be added in the future, but the following are currently possible: * writer * commenter * reader
view

string

Indicates the view for this access proposal. Only populated for proposals that belong to a view. published is the only supported value.