Sign in
Drive > Files > Dropbox

Get drop-boxes

Get an array of all dropbox available in the drive.

get/3/drive/{drive_id}/files/dropboxes

Path parameters

drive_idinteger required

Drive identifier

Query parameters

withstring

Optional : Allows loading additional data about a resource, which may include related resources.

cursorstring

The cursor parameter must be provided to fetch the subsequent batch of results. It essentially acts as a marker, indicating the point at which to begin retrieving the next set or page of the list

limitinteger

The maximum number of items returned

order_bystring[]
order'asc' | 'desc'

Specifies the default sorting direction for any order_by parameters provided

order_forstring[]

Response

OK

result'success' | 'error' | 'asynchronous' required

Result of the HTTP request

cursorstring nullable required

Cursor pagination uses a cursor to track the current position in the dataset. This cursor should be passed back in the subsequent API request in order to retrieve the next set of results or page of the list.

has_moreboolean required

The has_more boolean flag indicates whether additional items are available beyond the current page of results.

response_atinteger required

The timestamp, in seconds, indicating when the dataset was generated.

Example response

{
  "result": "success",
  "data": [
    {
      "name": "Directory V3",
      "path": "/full/path/Directory V3",
      "type": "file",
      "status": "locked",
      "drive_id": 1111,
      "depth": 3,
      "shared_root_id": 1,
      "sharelink": {
        "url": "https://kdrive.infomaniak.com/app/share/xxxx/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
        "right": "inherit"
      },
      "lock": {
        "description": "365",
        "token": "onlyoffice:123456"
      },
      "categories": [
        {
          "user_validation": "TO_VALIDATE",
          "category": {
            "color": "#FF1493"
          }
        }
      ],
      "color": "#0098ff",
      "external_import": {
        "application": "dropbox",
        "status": "canceled"
      },
      "rewind": {
        "status": "canceled",
        "mode": "directory",
        "archiving": "all"
      }
    }
  ],
  "cursor": "SGVsbG8gV29ybGQ"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.