Skip to main content
GET
/
folder
/
v1
/
files
/
{folderId}
cURL
curl --request GET \
  --url https://aodocs.altirnao.com/api/folder/v1/files/{folderId} \
  --header 'Authorization: Bearer <token>'
{
  "editable": true,
  "editableDocuments": true,
  "fileId": "<string>",
  "folderAodocsId": "<string>",
  "folderDefinitionId": "<string>",
  "folderIsRoot": true,
  "kind": "<string>",
  "libraryId": "<string>",
  "libraryName": "<string>",
  "name": "<string>",
  "parentFolderAodocsId": "<string>",
  "parentFolderDriveId": "<string>",
  "parentFolderIsRoot": true,
  "permittedOperations": [
    "DELETE"
  ],
  "resourceKey": "<string>",
  "restrictedDownload": true,
  "subfolders": "<array>"
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
folderId
string
required

Query Parameters

​
securityCode
string

The security code

​
domain
string

The G Suite domain

Response

200 - application/json

A ApiFolder response

​
editable
boolean

Whether the folder is editable by the current user (read-only field)

​
editableDocuments
boolean

Whether the documents in the folder are editable by the current user (read-only field)

​
fileId
string

The ID of the folder in Drive

​
folderAodocsId
string

The ID of the folder in AODocs model (0 if root folder)

​
folderDefinitionId
string

(Deprecated) The ID of the folder configuration

​
folderIsRoot
boolean

Whether the folder is the root folder (read-only field)

​
kind
string
​
libraryId
string

The ID of the library

​
libraryName
string

The name of the library

​
name
string

The name of the folder

​
parentFolderAodocsId
string

The ID of the parent folder in AODocs model (0 if root folder)

​
parentFolderDriveId
string

The ID of the parent folder in Drive

​
parentFolderIsRoot
boolean

Whether the parent folder is the root folder (read-only field)

​
permittedOperations
enum<string>[]

The list of permitted operations to the current user (read-only field)

Available options:
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
string

A folder that is shared with the link may only be discovered with this resourceKey

​
restrictedDownload
boolean

Whether the documents in the folder are marked as restricted to download, copy and print (for the readers)

​
subfolders
array

The list of subfolders