Method: drives.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists the user's shared drives.
This method accepts the q
parameter, which is a search query combining one or more search terms. For more information, see the Search for shared drives guide.
HTTP request
GET https://www.googleapis.com/drive/v3/drives
The URL uses gRPC Transcoding syntax.
Query parameters
Parameters |
pageSize |
integer
Maximum number of shared drives to return per page.
|
pageToken |
string
Page token for shared drives.
|
q |
string
Query string for searching shared drives.
|
useDomainAdminAccess |
boolean
Issue the request as a domain administrator; if set to true, then all shared drives of the domain in which the requester is an administrator are returned.
|
Request body
The request body must be empty.
Response body
A list of shared drives.
If successful, the response body contains data with the following structure:
JSON representation |
{
"drives": [
{
object (Drive )
}
],
"nextPageToken": string,
"kind": string
} |
Fields |
drives[] |
object (Drive )
The list of shared drives. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.
|
nextPageToken |
string
The page token for the next page of shared drives. This will be absent if the end of the 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. The page token is typically valid for several hours. However, if new items are added or removed, your expected results might differ.
|
kind |
string
Identifies what kind of resource this is. Value: the fixed string "drive#driveList" .
|
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/drive
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-07-23 UTC.
[null,null,["Last updated 2025-07-23 UTC."],[],[],null,["# Method: drives.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.DriveList.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\n\u003cbr /\u003e\n\nLists the user's shared drives.\n\nThis method accepts the `q` parameter, which is a search query combining one or more search terms. For more information, see the [Search for shared drives](/workspace/drive/api/guides/search-shareddrives) guide.\n\n### HTTP request\n\n`GET https://www.googleapis.com/drive/v3/drives`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` Maximum number of shared drives to return per page. |\n| `pageToken` | `string` Page token for shared drives. |\n| `q` | `string` Query string for searching shared drives. |\n| `useDomainAdminAccess` | `boolean` Issue the request as a domain administrator; if set to true, then all shared drives of the domain in which the requester is an administrator are returned. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nA list of shared drives.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"drives\": [ { object (/workspace/drive/api/reference/rest/v3/drives#Drive) } ], \"nextPageToken\": string, \"kind\": string } ``` |\n\n| Fields ||\n|-----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `drives[]` | `object (`[Drive](/workspace/drive/api/reference/rest/v3/drives#Drive)`)` The list of shared drives. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched. |\n| `nextPageToken` | `string` The page token for the next page of shared drives. This will be absent if the end of the 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. The page token is typically valid for several hours. However, if new items are added or removed, your expected results might differ. |\n| `kind` | `string` Identifies what kind of resource this is. Value: the fixed string `\"drive#driveList\"`. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/drive`\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)."]]