Google Drive Accessproposals API

openapi: 3.2.0
info:
  title: Google Drive Accessproposals 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: accessproposals
paths:
  /files/{fileId}/accessproposals/{proposalId}:
    get:
      operationId: getAccessproposal
      summary: Retrieves an access proposal by ID
      description: Retrieves an access proposal by ID. For more information, see Manage pending access proposals.
      tags:
      - accessproposals
      x-discovery-id: drive.accessproposals.get
      parameters:
      - name: fileId
        in: path
        required: true
        schema:
          type: string
        description: Required. The ID of the item the request is on.
      - name: proposalId
        in: path
        required: true
        schema:
          type: string
        description: Required. The ID of the access proposal to resolve.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccessProposal'
        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.file
        - https://www.googleapis.com/auth/drive.metadata
        - https://www.googleapis.com/auth/drive.metadata.readonly
        - https://www.googleapis.com/auth/drive.readonly
  /files/{fileId}/accessproposals:
    get:
      operationId: listAccessproposals
      summary: List the access proposals on a file
      description: 'List the access proposals on a file. For more information, see Manage pending access proposals. Note: Only approvers are able to list access proposals on a file. If the user isn''t an approver, a 403 error is returned.'
      tags:
      - accessproposals
      x-discovery-id: drive.accessproposals.list
      parameters:
      - name: fileId
        in: path
        required: true
        schema:
          type: string
        description: Required. The ID of the item the request is on.
      - name: pageToken
        in: query
        required: false
        schema:
          type: string
        description: Optional. The continuation token on the list of access requests.
      - name: pageSize
        in: query
        required: false
        schema:
          type: integer
          format: int32
        description: Optional. The number of results per page.
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListAccessProposalsResponse'
        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.file
        - https://www.googleapis.com/auth/drive.metadata
        - https://www.googleapis.com/auth/drive.metadata.readonly
        - https://www.googleapis.com/auth/drive.readonly
  /files/{fileId}/accessproposals/{proposalId}:resolve:
    post:
      operationId: resolveAccessproposals
      summary: Approves or denies an access proposal
      description: Approves or denies an access proposal. For more information, see Manage pending access proposals.
      tags:
      - accessproposals
      x-discovery-id: drive.accessproposals.resolve
      parameters:
      - name: fileId
        in: path
        required: true
        schema:
          type: string
        description: Required. The ID of the item the request is on.
      - name: proposalId
        in: path
        required: true
        schema:
          type: string
        description: Required. The ID of the access proposal to resolve.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ResolveAccessProposalRequest'
      responses:
        '200':
          description: Successful response
        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.file
components:
  schemas:
    ListAccessProposalsResponse:
      type: object
      description: The response to an access proposal list request.
      properties:
        nextPageToken:
          type: string
          description: 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.
        accessProposals:
          type: array
          description: The list of access proposals. This field is only populated in Drive API v3.
          items:
            $ref: '#/components/schemas/AccessProposal'
    ResolveAccessProposalRequest:
      type: object
      description: Request message for resolving an AccessProposal on a file.
      properties:
        action:
          type: string
          description: Required. The action to take on the access proposal.
          enum:
          - ACTION_UNSPECIFIED
          - ACCEPT
          - DENY
        view:
          type: string
          description: Optional. Indicates the view for this access proposal. This should only be set when the proposal belongs to a view. Only `published` is supported.
        sendNotification:
          type: boolean
          description: Optional. Whether to send an email to the requester when the access proposal is denied or accepted.
        role:
          type: array
          description: 'Optional. The roles that the approver has allowed, if any. For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles). Note: This field is required for the `ACCEPT` action.'
          items:
            type: string
    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
    AccessProposalRoleAndView:
      type: object
      description: A wrapper for the role and view of an access proposal. For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles).
      properties:
        role:
          type: string
          description: 'The role that was proposed by the requester. The supported values are: * `writer` * `commenter` * `reader`'
        view:
          type: string
          description: Indicates the view for this access proposal. Only populated for proposals that belong to a view. Only `published` is supported.
    AccessProposal:
      type: object
      description: Manage outstanding access proposals on a file.
      properties:
        rolesAndViews:
          type: array
          description: A wrapper for the role and view of an access proposal. For more information, see [Roles and permissions](https://developers.google.com/workspace/drive/api/guides/ref-roles).
          items:
            $ref: '#/components/schemas/AccessProposalRoleAndView'
        createTime:
          type: string
          description: The creation time.
          format: google-datetime
        requestMessage:
          type: string
          description: The message that the requester added to the proposal.
        fileId:
          type: string
          description: The file ID that the proposal for access is on.
        requesterEmailAddress:
          type: string
          description: The email address of the requesting user.
        recipientEmailAddress:
          type: string
          description: The email address of the user that will receive permissions, if accepted.
        proposalId:
          type: string
          description: The ID of the access proposal.
  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