View Folder Shares API
Request Info
Info |
Value |
Request URL |
/shares/_share_id_/folders/_folder_id_ |
Request VERB |
GET |
Response Parameters
Parameter |
Type |
Description |
id |
String |
The Unique ID for the share. |
name |
String |
The Name of the Share. |
deleted |
Boolean |
If the folder has been deleted or not. |
share_id |
String |
The ID of the Share. |
parent_folder_id |
String |
The ID of the Parent Folder. |
created_at |
DateTime |
When the folder was created |
update_at |
DateTime |
When the folder was last updated |
folders |
Folder |
Any Subfolders in this folder |
files |
File |
Any Files in this folder, please see the File API. |
Example Request in JSON
curl -X GET --user nkpIxMK9ucUUE7FvfNpdAf:x \
-H "Accept: application/json" \
https://test.host/shares/project-alpha/folders/goals
Example Response in JSON
{"folder":
{
"id":"goals",
"name":"Goals",
"deleted":false,
"share_id":"project-alpha",
"parent_folder_id":"root",
"created_at":"2017-01-11T02:58:39.000Z",
"updated_at":"2017-01-11T02:58:39.000Z",
"folders":[],
"files":
[
{
"id":"goals-2017-docx",
"folder_id":"goals",
"name":"Goals 2017.docx",
"size":22201,
"size_to_human":"22 KB",
"content_type":"application/zip",
"checksum":"86eedb67bf736834c96c5b2a4cefe9be280620fd",
"crc32":"2306f5b0",
"av_scanned":true,
"av_infected":false,
"deleted":false,
"created_at":"2017-01-11T03:18:52.000Z",
"updated_at":"2017-01-11T03:19:03.000Z"
}
]
}
}