Name |
Type |
Required |
Description |
Path |
String |
Yes |
The path to the folder. |
file_limit |
integer |
No |
Default is 10,000 (max is 25,000). When listing a folder, the service won't report listings containing more than the specified amount of files and will instead respond with a 406 (Not Acceptable) status response. |
hash |
String |
No |
Each call to /metadata on a folder will return a hash field, generated by hashing all of the metadata contained in that response. On later calls to /metadata, you should provide that value via this parameter so that if nothing has changed, the response will be a 304 (Not Modified) status code instead of the full, potentially very large, folder listing. This parameter is ignored if the specified path is associated with a file or if list=false. |
list |
boolean |
No |
The strings true and false are valid values. true is the default. If true, the folder's metadata will include a contents field with a list of metadata entries for the contents of the folder. If false, the contents field will be omitted. |
include_deleted |
Boolean |
No |
Only applicable when list is set. If this parameter is set to true, then contents will include the metadata of deleted children. Note that the target of the metadata call is always returned even when it has been deleted (with is_deleted set to true) regardless of this flag. |
rev |
string |
No |
If you include a particular revision number, then only the metadata for that revision will be returned. |
locale |
String |
No |
The metadata returned will have its size field translated based on the given locale. |
include_media_info |
boolean |
No |
If true, each file will include a photo_info dictionary for photos and a video_info dictionary for videos with additional media info. If the data isn't available yet, the string pending will be returned instead of a dictionary. |
include_membership |
boolean |
no |
If true, metadata for a shared folder will include a list of members and a list of groups. |