> ## Documentation Index
> Fetch the complete documentation index at: https://api.aodocs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get folderv1folders hierarchy

> Load necessary folders to display selectedFolder in the context of displayRootFolder



## OpenAPI

````yaml /openapis/folder.json get /folder/v1/folders/{displayRootFolderId}/hierarchy
openapi: 3.0.1
info:
  description: "The AODocs REST API exposes most of the features of AODocs. It can be used to implement custom applications, third-party integration, bulk tools, or\n\t\t\t\t\t\t\t\t\t\tjust to experiment with AODocs."
  version: '69.4'
  title: AODocs REST API
servers:
  - url: https://aodocs.altirnao.com/api
security: []
tags:
  - name: folder
    description: Lets you list existing folders, update folders, create new folders, ...
paths:
  /folder/v1/folders/{displayRootFolderId}/hierarchy:
    get:
      tags:
        - folder
      description: >-
        Load necessary folders to display selectedFolder in the context of
        displayRootFolder
      operationId: folder:v1.Folder.listFromDisplayRoot
      parameters:
        - name: displayRootFolderId
          in: path
          required: true
          schema:
            type: string
        - name: selectedFolder
          in: query
          required: false
          schema:
            type: string
        - $ref: '#/components/parameters/securityCode_query_parameter'
        - $ref: '#/components/parameters/domain_query_parameter'
      responses:
        '200':
          description: A ApiFolderList response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiFolderList'
      security:
        - google_id_token-a99f12e0:
            - https://www.googleapis.com/auth/userinfo.email
        - google_id_token_legacy-a99f12e0:
            - https://www.googleapis.com/auth/userinfo.email
components:
  parameters:
    securityCode_query_parameter:
      name: securityCode
      in: query
      description: The security code
      required: false
      schema:
        type: string
    domain_query_parameter:
      name: domain
      in: query
      description: The G Suite domain
      required: false
      schema:
        type: string
  schemas:
    ApiFolderList:
      type: object
      properties:
        items:
          type: array
          items:
            $ref: '#/components/schemas/ApiFolder'
        kind:
          type: string
    ApiFolder:
      type: object
      properties:
        editable:
          type: boolean
          description: Whether the folder is editable by the current user (read-only field)
        editableDocuments:
          type: boolean
          description: >-
            Whether the documents in the folder are editable by the current user
            (read-only field)
        fileId:
          type: string
          description: The ID of the folder in Drive
        folderAodocsId:
          type: string
          description: The ID of the folder in AODocs model (0 if root folder)
        folderDefinitionId:
          type: string
          description: (Deprecated) The ID of the folder configuration
        folderIsRoot:
          type: boolean
          description: Whether the folder is the root folder (read-only field)
        kind:
          type: string
        libraryId:
          type: string
          description: The ID of the library
        libraryName:
          type: string
          description: The name of the library
        name:
          type: string
          description: The name of the folder
        parentFolderAodocsId:
          type: string
          description: The ID of the parent folder in AODocs model (0 if root folder)
        parentFolderDriveId:
          type: string
          description: The ID of the parent folder in Drive
        parentFolderIsRoot:
          type: boolean
          description: Whether the parent folder is the root folder (read-only field)
        permittedOperations:
          type: array
          description: >-
            The list of permitted operations to the current user (read-only
            field)
          items:
            type: string
            enum:
              - DELETE
              - RENAME
              - MODIFY_ACL
              - VIEW_ACL
              - MOVE_TO_ANOTHER_FOLDER
              - EXPORT
              - EDIT_PROPERTIES
              - COPY
              - CREATE_COPY_FROM
              - EXPORT_COPY
              - CREATE_NEW_VERSION
              - ATTACHMENT_VERSION_REPLACE
              - ATTACHMENT_VERSION_CREATE
              - ADD_NEW_ATTACHMENT_FROM_DRIVE
              - ATTACH_ENCRYPTED_FILE
              - OPEN_IN_OFFICE
              - PUBLISH
              - UNPUBLISH
              - RESTORE_REVISION
              - REVERT_TO_THIS_REVISION
              - CREATE_RELATED_DOCUMENT
              - DOWNLOAD
              - DOWNLOAD_ATTACHMENT
              - NOTIFY_USERS
              - CHECK_IN
              - CHECK_OUT
              - DISCARD_CHECKOUT
              - FORCE_DISCARD_CHECKOUT
              - EDIT_TAGS
              - PERFORM_HUMAN_WORKFLOW_ACTIONS
              - VIEW_DRAFT
              - SHARE_PUBLICLY
              - VIEW_HISTORY
              - VIEW_VERSIONS
              - ADD_COMMENT
              - SET_TEMPLATE_AS_DEFAULT
              - SET_TEMPLATE_VISIBILITY_SCOPE
              - DELETE_COMMENT
              - KNOW_DRAFT
              - FORCE_PARALLEL_TRANSITION
              - CHANGE_WORKFLOW_STATE_DIRECTLY
              - SEE_HIDDEN_FIELDS
              - VIEW_TRASHED_ITEM
              - UNTRASH
              - PERMANENTLY_DELETE
              - VIEW_DRIVEONLY_ACL
              - MODIFY_DRIVEONLY_ACL
              - NON_GOOGLE_USERS_SUPPORT
              - SUPPORTS_LIVE_EVALUATION
              - ALLOWLIST_NOT_ENFORCED
              - CREATE_SUBFOLDER
              - CREATE_DOCUMENT_IN_THIS_FOLDER
              - IMPORT_FOLDERS_FROM_DRIVE_TO_THIS_FOLDER
              - ADD_NEW_ATTACHMENT_FROM_OSS
              - OPEN_IN_DRIVE
              - COPY_FOLDER_TREE
              - CHECK_FOLDER
              - MOVE_TO_DRIVE
              - COPY_TO_DRIVE
              - MOVE_TO_ANOTHER_LIBRARY
              - MOVE_TO_ANOTHER_CLASS
              - COPY_TO_ANOTHER_CLASS
              - COPY_ATTACHMENT
              - COPY_TO_ANOTHER_LIBRARY
              - EDIT_ATTACHMENT
        resourceKey:
          type: string
          description: >-
            A folder that is shared with the link may only be discovered with
            this resourceKey
        restrictedDownload:
          type: boolean
          description: >-
            Whether the documents in the folder are marked as restricted to
            download, copy and print (for the readers)
        subfolders:
          type: array
          description: The list of subfolders
          items:
            $ref: '#/components/schemas/ApiFolder'
  securitySchemes:
    google_id_token-a99f12e0:
      type: oauth2
      x-google-issuer: https://accounts.google.com
      x-google-jwks_uri: https://www.googleapis.com/oauth2/v1/certs
      x-google-audiences: >-
        755040865326-h5gomu85549lkh2qf9d3lku39vnaf6ii.apps.googleusercontent.com,563231141203-231sn7f6ptedncun5h00h7ktbe3o2nd5.apps.googleusercontent.com,993707107224.apps.googleusercontent.com,ao-docs,aodocs-core-eu-1,ao-docs-staging,ao-docs-dev,aodocs-core-dev-us,aodocs-total-poc-euw3
      flows:
        implicit:
          authorizationUrl: https://accounts.google.com/o/oauth2/v2/auth
          scopes:
            https://www.googleapis.com/auth/userinfo.email: View your email address
    google_id_token_legacy-a99f12e0:
      type: oauth2
      x-google-issuer: accounts.google.com
      x-google-jwks_uri: https://www.googleapis.com/oauth2/v1/certs
      x-google-audiences: >-
        755040865326-h5gomu85549lkh2qf9d3lku39vnaf6ii.apps.googleusercontent.com,563231141203-231sn7f6ptedncun5h00h7ktbe3o2nd5.apps.googleusercontent.com,993707107224.apps.googleusercontent.com,ao-docs,aodocs-core-eu-1,ao-docs-staging,ao-docs-dev,aodocs-core-dev-us,aodocs-total-poc-euw3
      flows:
        implicit:
          authorizationUrl: https://accounts.google.com/o/oauth2/v2/auth
          scopes:
            https://www.googleapis.com/auth/userinfo.email: View your email address

````