Cloud Storage

Gets a list of items from a cloud storage provider

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

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.

Authorization

OAuth2
AuthorizationBearer <token>

OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.

In: header

Path Parameters

accountId*string

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

folderId*string

The ID of the folder.

serviceId*string

The ID of the service to access.

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

userId*string

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_path?string

The file path to a cloud storage folder.

cloud_storage_folderid_plain?string

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.

count?string

The maximum number of results to return.

Use start_position to specify the number of results to skip.

Default: 25

order?string

The order in which to sort the results.

Valid values are:

  • asc: Ascending order.
  • desc: Descending order.
order_by?string

The file attribute to use to sort the results.

Valid values are:

  • modified
  • name
search_text?string

Use this parameter to search for specific text.

sky_drive_skip_token?string
start_position?string

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 Body

application/json

application/json

curl -X GET "https://example.com/v2.1/accounts/string/users/string/cloud_storage/string/folders/string"
{  "endPosition": "string",  "errorDetails": {    "authenticationUrl": "string",    "errorCode": "string",    "message": "string"  },  "id": "string",  "items": [    {      "date": "string",      "hasCompositeTemplate": "string",      "id": "string",      "img": "string",      "name": "string",      "ownerName": "string",      "size": "string",      "supported": "string",      "type": "string",      "uri": "string"    }  ],  "name": "string",  "nextUri": "string",  "previousUri": "string",  "resultSetSize": "string",  "skyDriveSkipToken": "string",  "startPosition": "string",  "totalSetSize": "string"}