Links
Dropbox API
Getting access, Developing, Testing
Back to Dropbox
Paper - Docs - Get Folder Info
Retrieves folder information for the given Paper doc. This includes:
- folder sharing policy; permissions for subfolders are set by the top-level folder.
- full 'filepath', i.e. the list of folders (both folderId and folderName) from the root folder to the folder directly containing the Paper doc.
Note: If the Paper doc is not in any folder (aka unfiled) the response will be empty.
Input
type: object
properties:
data:
type: object
description: |
doc_id: The Paper doc ID.
properties:
doc_id:
type: string
description: The Paper doc ID.
title: Data
Output
type: object
description: >
Metadata about Paper folders containing the specififed Paper doc.
folder_sharing_policy_type: The sharing policy of the folder containing the
Paper doc.
folders: The folder path. If present the first folder is the root folder.
properties:
folders:
type: array
description: The folder path. If present the first folder is the root folder.
items:
type: object
description: |
Data structure representing a Paper folder.
id: Paper folder ID. This ID uniquely identifies the folder.
name: Paper folder name.
properties:
id:
type: string
description: Paper folder ID. This ID uniquely identifies the folder.
name:
type: string
description: Paper folder name.
folder_sharing_policy_type:
type: object
description: >
The sharing policy of a Paper folder.
Note: The sharing policy of subfolders is inherited from the root folder.
team: Everyone in your team and anyone directly invited can access this
folder.
invite_only: Only people directly invited can access this folder.
properties:
.tag:
title: Choice of FolderSharingPolicyType
type: string
enum:
- team
- invite_only