LiquidFiles Documentation
LiquidFiles Documentation

List Shares API

Request Info
Info Value
Request URL /shares/_share_id_
Request VERB GET
Response Parameters
Parameter Type Description
id String The Unique ID for the share.
name String The Name of the Share.
access String 'read' or 'write' depending on if the API user has read or write access to the share.
view_log Boolean true if the user can view the share log.
created_at DateTime When the share was created
update_at DateTime When the share was last updated
root_folder Folder API
  • id: Root folder id
  • share_id: The Share ID
  • folders: The Folders in the root folder. Please see the Folder API for more info.
  • files: The Files in the root folder. Please see the Files API for more info.

Example Request in JSON

curl -X GET -H "Accept: application/json" -H "Content-Type: application/json" --user nkpIxMK9ucUUE7FvfNpdAf:x https://test.host/shares/project-alpha

Example Response in JSON

{"share":
  {
    "id":"project-alpha",
    "name":"Project Alpha",
    "access":"write",
    "view_log":true,
    "created_at":"2017-01-05T09:48:14.000Z",
    "updated_at":"2017-01-05T09:48:14.000Z",
    "root_folder":
    {
      "id":"root",
      "share_id":"project-alpha",
      "folders": 
      [
          {
            "id":"meeting-notes",
            "name":"Meeting Notes",
            "deleted":false,
            "share_id":"project-alpha",
            "parent_folder_id":"root",
            "created_at":"2017-01-11T02:58:14.000Z",
            "updated_at":"2017-01-11T02:58:14.000Z"
          },{
            "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"
          }
      ],
      "files":
      [
        {
          "id":"readme-txt",
          "folder_id":"root",
          "name":"Readme.txt",
          "size":6,
          "size_to_human":"6.0 B",
          "content_type":"text/plain",
          "checksum":"0446cddf8b5605ce3bf664e6be5d29689cb4d295",
          "crc32":"809983c5",
          "av_scanned":true,
          "av_infected":false,
          "deleted":false,
          "created_at":"2017-01-11T03:19:13.000Z",
          "updated_at":"2017-01-11T03:19:23.000Z"
        }
      ]
    }
  }
}