Sign in

v1

latestSwagger 2.02026-07-134146194.6 MB
CloudStorage

Gets a list of items from a cloud storage provider.

Retrieves a list of the user's items from the specified cloud storage provider.

To limit the scope of the items returned, provide a comma-separated list of folder IDs in the request.

get/v2.1/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}/folders/{folderId}

Path parameters

accountIdstring required

The external account number (int) or account ID GUID.

folderIdstring required

The ID of the folder.

serviceIdstring required

The ID of the service to access.

Valid values are the service name ("Box") or the numerical serviceId ("4136").

userIdstring required

The ID of the user to access.

Note: Users can only access their own information. A user, even one with Admin rights, cannot access another user's settings.

Query parameters

cloud_storage_folder_pathstring

The file path to a cloud storage folder.

cloud_storage_folderid_plainstring

A plain-text folder ID that you can use as an alternative to the existing folder id. This property is mainly used for rooms. Enter multiple folder IDs as a comma-separated list.

countstring

The maximum number of results to return.

Use start_position to specify the number of results to skip.

Default: 25

orderstring

The order in which to sort the results.

Valid values are:

  • asc: Ascending order.
  • desc: Descending order.
order_bystring

The file attribute to use to sort the results.

Valid values are:

  • modified
  • name
search_textstring

Use this parameter to search for specific text.

sky_drive_skip_tokenstring
start_positionstring

The zero-based index of the result from which to start returning results.

Use with count to limit the number of results.

The default value is 0.

Response

Successful response.