Method: accessproposals.list
Stay organized with collections
Save and categorize content based on your preferences.
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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-04-18 UTC.
[null,null,["Last updated 2025-04-18 UTC."],[],[],null,["# Method: accessproposals.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListAccessProposalsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nList 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.\n\n### HTTP request\n\n`GET https://www.googleapis.com/drive/v3/files/{fileId}/accessproposals`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|----------------------------------------------------------|\n| `fileId` | `string` Required. The id of the item the request is on. |\n\n### Query parameters\n\n| Parameters ||\n|-------------|---------------------------------------------------------------------------|\n| `pageToken` | `string` Optional. The continuation token on the list of access requests. |\n| `pageSize` | `integer` Optional. The number of results per page |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nThe response to an Access Proposal list request.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"accessProposals\": [ { object (/workspace/drive/api/reference/rest/v3/accessproposals#AccessProposal) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `accessProposals[]` | `object (`[AccessProposal](/workspace/drive/api/reference/rest/v3/accessproposals#AccessProposal)`)` The list of Access Proposals. This field is only populated in v3 and v3beta. |\n| `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. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/docs`\n- `\n https://www.googleapis.com/auth/drive`\n- `\n https://www.googleapis.com/auth/drive.file`\n- `\n https://www.googleapis.com/auth/drive.metadata`\n- `\n https://www.googleapis.com/auth/drive.metadata.readonly`\n- `\n https://www.googleapis.com/auth/drive.readonly`\n\nSome scopes are restricted and require a security assessment for your app to use them. For more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
