Google Drive Teamdrives API
The teamdrives API from Google Drive — 2 operation(s) for teamdrives.
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/google-drive:google-drive-teamdrives-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Google Drive Teamdrives API
description: The Google Drive API allows clients to access resources from Google Drive.
version: v3
contact:
name: Google
url: https://developers.google.com/workspace/drive/
termsOfService: https://developers.google.com/terms
x-generated-from: google-discovery
x-source: https://www.googleapis.com/discovery/v1/apis/drive/v3/rest
x-discovery-revision: '20261102'
x-generated: '2026-11-04'
servers:
- url: https://www.googleapis.com/drive/v3
description: Google Drive REST API v3
security:
- oauth2: []
tags:
- name: teamdrives
paths:
/teamdrives/{teamDriveId}:
delete:
operationId: deleteTeamdrive
summary: 'Deprecated: Use `drives.delete` instead'
description: 'Deprecated: Use `drives.delete` instead.'
tags:
- teamdrives
x-discovery-id: drive.teamdrives.delete
parameters:
- name: teamDriveId
in: path
required: true
schema:
type: string
description: The ID of the Team Drive
responses:
'200':
description: Successful response
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
security:
- oauth2:
- https://www.googleapis.com/auth/drive
patch:
operationId: updateTeamdrive
summary: 'Deprecated: Use `drives.update` instead'
description: 'Deprecated: Use `drives.update` instead.'
tags:
- teamdrives
x-discovery-id: drive.teamdrives.update
parameters:
- name: teamDriveId
in: path
required: true
schema:
type: string
description: The ID of the Team Drive
- name: useDomainAdminAccess
in: query
required: false
schema:
type: boolean
default: 'false'
description: Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the Team Drive belongs.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TeamDrive'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/TeamDrive'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
security:
- oauth2:
- https://www.googleapis.com/auth/drive
get:
operationId: getTeamdrive
summary: 'Deprecated: Use `drives.get` instead'
description: 'Deprecated: Use `drives.get` instead.'
tags:
- teamdrives
x-discovery-id: drive.teamdrives.get
parameters:
- name: teamDriveId
in: path
required: true
schema:
type: string
description: The ID of the Team Drive
- name: useDomainAdminAccess
in: query
required: false
schema:
type: boolean
default: 'false'
description: Issue the request as a domain administrator; if set to true, then the requester will be granted access if they are an administrator of the domain to which the Team Drive belongs.
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/TeamDrive'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
security:
- oauth2:
- https://www.googleapis.com/auth/drive
- https://www.googleapis.com/auth/drive.readonly
/teamdrives:
get:
operationId: listTeamdrives
summary: 'Deprecated: Use `drives.list` instead'
description: 'Deprecated: Use `drives.list` instead.'
tags:
- teamdrives
x-discovery-id: drive.teamdrives.list
parameters:
- name: pageSize
in: query
required: false
schema:
type: integer
format: int32
default: '10'
description: Maximum number of Team Drives to return.
- name: q
in: query
required: false
schema:
type: string
description: Query string for searching Team Drives.
- name: pageToken
in: query
required: false
schema:
type: string
description: Page token for Team Drives.
- name: useDomainAdminAccess
in: query
required: false
schema:
type: boolean
default: 'false'
description: Issue the request as a domain administrator; if set to true, then all Team Drives of the domain in which the requester is an administrator are returned.
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/TeamDriveList'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
security:
- oauth2:
- https://www.googleapis.com/auth/drive
- https://www.googleapis.com/auth/drive.readonly
post:
operationId: createTeamdrive
summary: 'Deprecated: Use `drives.create` instead'
description: 'Deprecated: Use `drives.create` instead.'
tags:
- teamdrives
x-discovery-id: drive.teamdrives.create
parameters:
- name: requestId
in: query
required: true
schema:
type: string
description: Required. An ID, such as a random UUID, which uniquely identifies this user's request for idempotent creation of a Team Drive. A repeated request by the same user and with the same request ID will avoid creating duplicates by attempting to create the same Team Drive. If the Team Drive already exists a 409 error will be returned.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TeamDrive'
responses:
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/TeamDrive'
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
security:
- oauth2:
- https://www.googleapis.com/auth/drive
components:
schemas:
ErrorResponse:
type: object
description: Google API error envelope (https://cloud.google.com/apis/design/errors)
properties:
error:
type: object
properties:
code:
type: integer
message:
type: string
errors:
type: array
items:
type: object
properties:
domain:
type: string
reason:
type: string
message:
type: string
location:
type: string
locationType:
type: string
TeamDrive:
type: object
description: 'Deprecated: use the drive collection instead. Next ID: 33'
properties:
name:
type: string
description: The name of this Team Drive.
createdTime:
type: string
description: The time at which the Team Drive was created (RFC 3339 date-time).
format: date-time
colorRgb:
type: string
description: The color of this Team Drive as an RGB hex string. It can only be set on a `drive.teamdrives.update` request that does not set `themeId`.
restrictions:
type: object
description: A set of restrictions that apply to this Team Drive or items inside this Team Drive.
properties:
adminManagedRestrictions:
type: boolean
description: Whether administrative privileges on this Team Drive are required to modify restrictions.
domainUsersOnly:
type: boolean
description: Whether access to this Team Drive and items inside this Team Drive is restricted to users of the domain to which this Team Drive belongs. This restriction may be overridden by other sharing policies controlled outside of this Team Drive.
copyRequiresWriterPermission:
type: boolean
description: Whether the options to copy, print, or download files inside this Team Drive, should be disabled for readers and commenters. When this restriction is set to `true`, it will override the similarly named field to `true` for any file inside this Team Drive.
downloadRestriction:
$ref: '#/components/schemas/DownloadRestriction'
teamMembersOnly:
type: boolean
description: Whether access to items inside this Team Drive is restricted to members of this Team Drive.
sharingFoldersRequiresOrganizerPermission:
type: boolean
description: If true, only users with the organizer role can share folders. If false, users with either the organizer role or the file organizer role can share folders.
themeId:
type: string
description: The ID of the theme from which the background image and color will be set. The set of possible `teamDriveThemes` can be retrieved from a `drive.about.get` response. When not specified on a `drive.teamdrives.create` request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set `colorRgb` or `backgroundImageFile`.
capabilities:
type: object
description: Capabilities the current user has on this Team Drive.
properties:
canTrashChildren:
type: boolean
description: Whether the current user can trash children from folders in this Team Drive.
canListChildren:
type: boolean
description: Whether the current user can list the children of folders in this Team Drive.
canRename:
type: boolean
description: Whether the current user can rename files or folders in this Team Drive.
canChangeTeamDriveBackground:
type: boolean
description: Whether the current user can change the background of this Team Drive.
canChangeSharingFoldersRequiresOrganizerPermissionRestriction:
type: boolean
description: Whether the current user can change the `sharingFoldersRequiresOrganizerPermission` restriction of this Team Drive.
canRenameTeamDrive:
type: boolean
description: Whether the current user can rename this Team Drive.
canReadRevisions:
type: boolean
description: Whether the current user can read the revisions resource of files in this Team Drive.
canDownload:
type: boolean
description: Whether the current user can download files in this Team Drive.
canCopy:
type: boolean
description: Whether the current user can copy files in this Team Drive.
canChangeTeamMembersOnlyRestriction:
type: boolean
description: Whether the current user can change the `teamMembersOnly` restriction of this Team Drive.
canDeleteChildren:
type: boolean
description: Whether the current user can delete children from folders in this Team Drive.
canEdit:
type: boolean
description: Whether the current user can edit files in this Team Drive
canChangeDownloadRestriction:
type: boolean
description: Output only. Whether the current user can change organizer-applied download restrictions of this shared drive.
readOnly: true
canChangeCopyRequiresWriterPermissionRestriction:
type: boolean
description: Whether the current user can change the `copyRequiresWriterPermission` restriction of this Team Drive.
canRemoveChildren:
type: boolean
description: 'Deprecated: Use `canDeleteChildren` or `canTrashChildren` instead.'
canManageMembers:
type: boolean
description: Whether the current user can add members to this Team Drive or remove them or change their role.
canChangeDomainUsersOnlyRestriction:
type: boolean
description: Whether the current user can change the `domainUsersOnly` restriction of this Team Drive.
canComment:
type: boolean
description: Whether the current user can comment on files in this Team Drive.
canShare:
type: boolean
description: Whether the current user can share files or folders in this Team Drive.
canAddChildren:
type: boolean
description: Whether the current user can add children to folders in this Team Drive.
canDeleteTeamDrive:
type: boolean
description: Whether the current user can delete this Team Drive. Attempting to delete the Team Drive may still fail if there are untrashed items inside the Team Drive.
canResetTeamDriveRestrictions:
type: boolean
description: Whether the current user can reset the Team Drive restrictions to defaults.
kind:
type: string
description: 'Identifies what kind of resource this is. Value: the fixed string `"drive#teamDrive"`.'
default: drive#teamDrive
backgroundImageFile:
type: object
description: The background image file for a Team Drive.
properties:
yCoordinate:
type: number
description: The Y coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the vertical distance from the top side of the entire image to the top side of the cropping area divided by the height of the entire image.
format: float
width:
type: number
description: The width of the cropped image in the closed range of 0 to 1. This value represents the width of the cropped image divided by the width of the entire image. The height is computed by applying a width to height aspect ratio of 80 to 9. The resulting image must be at least 1280 pixels wide and 144 pixels high.
format: float
id:
type: string
description: The ID of an image file in Drive to use for the background image.
xCoordinate:
type: number
description: The X coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the horizontal distance from the left side of the entire image to the left side of the cropping area divided by the width of the entire image.
format: float
id:
type: string
description: The ID of this Team Drive which is also the ID of the top level folder of this Team Drive.
orgUnitId:
type: string
description: The organizational unit of this shared drive. This field is only populated on `drives.list` responses when the `useDomainAdminAccess` parameter is set to `true`.
backgroundImageLink:
type: string
description: A short-lived link to this Team Drive's background image.
TeamDriveList:
type: object
description: A list of Team Drives.
properties:
nextPageToken:
type: string
description: The page token for the next page of Team Drives. This will be absent if the end of the Team Drives 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:
type: string
description: 'Identifies what kind of resource this is. Value: the fixed string `"drive#teamDriveList"`.'
default: drive#teamDriveList
teamDrives:
type: array
description: The list of Team Drives. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.
items:
$ref: '#/components/schemas/TeamDrive'
DownloadRestriction:
type: object
description: A restriction for copy and download of the file.
properties:
restrictedForReaders:
type: boolean
description: Whether download and copy is restricted for readers.
restrictedForWriters:
type: boolean
description: Whether download and copy is restricted for writers. If true, download is also restricted for readers.
securitySchemes:
oauth2:
type: oauth2
flows:
authorizationCode:
authorizationUrl: https://accounts.google.com/o/oauth2/auth
tokenUrl: https://oauth2.googleapis.com/token
scopes:
https://www.googleapis.com/auth/drive.scripts: Modify your Google Apps Script scripts' behavior
https://www.googleapis.com/auth/drive.meet.readonly: See and download your Google Drive files that were created or edited by Google Meet.
https://www.googleapis.com/auth/drive: See, edit, create, and delete all of your Google Drive files
https://www.googleapis.com/auth/drive.appdata: See, create, and delete its own configuration data in your Google Drive
https://www.googleapis.com/auth/drive.file: See, edit, create, and delete only the specific Google Drive files you use with this app
https://www.googleapis.com/auth/drive.apps.readonly: View your Google Drive apps
https://www.googleapis.com/auth/drive.photos.readonly: View the photos, videos and albums in your Google Photos
https://www.googleapis.com/auth/drive.readonly: See and download all your Google Drive files
https://www.googleapis.com/auth/drive.metadata: View and manage metadata of files in your Google Drive
https://www.googleapis.com/auth/drive.metadata.readonly: See information about your Google Drive files