The 'folder' object contains the following attributes and properties:
| Attribute |
Type |
Description |
| id |
long |
Unique identifier for the folder. This can be used by applications for other API methods (move, copy, upload, rename, and more) |
| name |
string |
The name of the folder. |
| user_id |
long |
The id of the user who owns the folder. |
| description |
string |
The folder's description. This can be empty, as the folder may or may not have a description. |
| shared |
long (boolean) |
Whether this folder is being shared with others to view. "0" means the folder is private, "1" means the folder is shared and has an enabled shared_link. |
| shared_link |
string |
A URL to share with others to view the folder. |
| permissions |
string (enumerator) |
Provides information regarding a user's access permissions. If the value is "densuv" that means that the user has full permissions. Each character represents a permission as follows:
- "d" - downloading rights
- "e" - delete rights
- "n" - rename rights
- "s" - sharing rights
- "u" - upload rights
- "v" - viewing rights
|
| role |
string (enumerator) |
The user's role in this folder. Possible values can be:
- "owner" - the folder was created and is owned by this user.
- "editor" - the folder is owned by someone else, but this user has editing rights
- "viewer" - the folder is owned by someone else, but this user is permitted to view the content of the folder.
|
| Property |
Type |
Description |
| tags |
Base64Binary |
A list of the folder's tags (tag objects). |
| files |
Base64Binary |
A list of the folder's files (file objects). |
| folders |
Base64Binary |
A list of the folder's subfolders (folder objects). |
Need additional assistance? Please feel free to Contact us
