List files with the Google Drive API
Searches the files and folders the account can see. Each file comes with only id, name and mimeType unless fields asks for more, such as webViewLink, modifiedTime and parents. To leave out the trash, add trashed = false to q. Pass nextPageToken as pageToken to read the next page.
- Identifier
- google_drive_list_files
The request
POST https://connect.reportei.com/api/tools/google_drive_list_files/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"q": "<q>"
}
}Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| q | string | No | Search query in the Drive syntax, such as name contains 'budget' and trashed = false, 'FOLDER_ID' in parents with a folder id from this tool or root for the top of My Drive, or mimeType = 'application/vnd.google-apps.folder'. |
| fields | string | No | Fields to return, such as nextPageToken,files(id,name,mimeType,modifiedTime,webViewLink,parents). Keep nextPageToken in the list to page. |
| pageSize | integer | No | Files per page, up to 1000. Always set it: without it a search in My Drive returns every matching file at once. |
| pageToken | string | No | The nextPageToken of the previous response. |
| orderBy | string | No | Comma-separated sort keys, each one optionally followed by desc, such as modifiedTime desc or folder,name. Keys: createdTime, folder, modifiedByMeTime, modifiedTime, name, name_natural, quotaBytesUsed, recency, sharedWithMeTime, starred and viewedByMeTime. |
| corpora | string | No | Where to search: user, the default, is My Drive and the files shared with the account; drive is one shared drive, given in driveId; allDrives is everything, and slower.Values: user, drive, allDrives, domain |
| driveId | string | No | Id of a shared drive from List shared drives, with corpora drive, includeItemsFromAllDrives and supportsAllDrives. |
| includeItemsFromAllDrives | boolean | No | Includes files of shared drives in the results. Needs supportsAllDrives set to true. |
| supportsAllDrives | boolean | No | Set to true to reach files of shared drives. |
Supported connections
Your customer connects their Google Drive account once, with one of the modes below. The same connection serves every tool of the toolkit.
OAuth with your product's app
You register your product's OAuth app once, with POST /api/merchants/credentials/google_drive, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.
The response
On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.
Ready for AI agents
This tool's input is a JSON Schema, available at GET /api/tools/google_drive_list_files. It becomes your agent's tool definition with no conversion.
Other Google Drive tools
- Get fileGETGets the metadata of a file or folder, not its content. webViewLink is the address that opens it in the browser, and parents has the id of the folder it is in.
- Create filePOSTCreates a file with metadata only, without content: a folder, or an empty Google Doc, Sheet or Slides presentation, chosen by mimeType. Returns id, name and mimeType, plus whatever fields asks for, such as webViewLink.
- Update filePATCHRenames, describes, stars, moves or trashes a file or folder; only the fields sent change. To move it, pass the new folder in addParents and the current one, from the parents of Get file, in removeParents. A folder of My Drive cannot move into a shared drive.
- Copy filePOSTCopies a file, such as a report template, and returns the new file. Without parents the copy stays in the same folder as the original. Folders cannot be copied.
- List shared drivesGETLists the shared drives the account is a member of, with id and name. The id goes in driveId of List files. Pass nextPageToken as pageToken to read the next page.
- List permissionsGETLists who has access to a file or folder. Without fields each permission has only basic fields, such as id, type and role: ask for emailAddress and displayName in fields to see who it is. Pass nextPageToken as pageToken to read the next page.
- Create permissionPOSTShares a file or folder and returns the new permission with its id. Google emails the users and groups it is shared with, unless sendNotificationEmail is false. emailAddress is required for type user or group, and domain for type domain.
- Update permissionPATCHChanges the role or the expiration of an access that already exists, and returns the permission.
Toolkits in the same category
See all 100 toolkitsSee Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
