Retrieves a list of all the items in all the folders associated with the user from the specified cloud storage provider. You can limit the scope of the returned items by providing a comma separated list of folder IDs in the request.

Request

HTTP request

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

Parameters

Parameter name Value Description
Path parameters
accountId string

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

folderId string

The ID of the folder being accessed.

serviceId string

The ID of the service to access.

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

userId string

The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing.

Optional query parameters
cloud_storage_folder_path string
count string

An optional value that sets how many items are included in the response.

The default setting for this is 25.

order string

An optional value that sets the direction order used to sort the item list.

Valid values are:

  • asc = ascending sort order
  • desc = descending sort order
order_by string

An optional value that sets the file attribute used to sort the item list.

Valid values are:

  • modified
  • name
search_text string
start_position string

Indicates the starting point of the first item included in the response set. It uses a 0-based index. The default setting for this is 0.

Responses

Code Description Reference
200 OK Successful response.
400 Bad Request Error encountered.

SDK Method

CloudStorage::list

Definitions Expand All | Collapse All

CloudStorage

Cloud storage

endPosition string

The last position in the result set.

errorDetails externalDocServiceErrorDetails
id string
items
[externalFile]
name string
nextUri string

The URI for the next chunk of records based on the search request. It is null if this is the last set of results for the search.

previousUri string

The URI for the prior chunk of records based on the search request. It is null if this is the first set of results for the search.

resultSetSize string

The number of results returned in this response.

startPosition string

Starting position of the current result set.

totalSetSize string

The total number of items in the search's result set. It will always be greater than or equal to the value of the resultSetSize field.

errorDetails

This object describes errors that occur. It is only valid for responses, and ignored in requests.

errorCode string

An error code associated with the error.

message string

A short error message.

externalDocServiceErrorDetails

authenticationUrl string

Reserved: TBD

errorCode string
message string

externalFile

date string
id string
img string
name string
size string

Reserved: TBD

supported string
type string

Type of the user. Valid values: type_owner, type_participant.

uri string

Examples

Generic JSON Response

Response

{
"name": "sample string 1",
"id": "sample string 2",
"previousUri": "sample string 3",
"nextUri": "sample string 4",
"totalSetSize": "sample string 5",
"resultSetSize": "sample string 6",
"startPosition": "sample string 7",
"endPosition": "sample string 8",
"items": [
{
"name": "sample string 1",
"id": "sample string 2",
"date": "sample string 3",
"img": "sample string 4",
"type": "sample string 5",
"uri": "sample string 6",
"size": "sample string 7",
"supported": "sample string 8"
}
]
,
"errorDetails": {
"errorCode": "sample string 1",
"message": "sample string 2",
"authenticationUrl": "sample string 3"
}
}

Generic XML Response

Response

<externalFolder 
xmlns:i="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.docusign.com/restapi">

<endPosition>sample string 8</endPosition>
<errorDetails>
<authenticationUrl>sample string 3</authenticationUrl>
<errorCode>sample string 1</errorCode>
<message>sample string 2</message>
</errorDetails>
<id>sample string 2</id>
<items>
<externalFile>
<date>sample string 3</date>
<id>sample string 2</id>
<img>sample string 4</img>
<name>sample string 1</name>
<size>sample string 7</size>
<supported>sample string 8</supported>
<type>sample string 5</type>
<uri>sample string 6</uri>
</externalFile>
</items>
<name>sample string 1</name>
<nextUri>sample string 4</nextUri>
<previousUri>sample string 3</previousUri>
<resultSetSize>sample string 6</resultSetSize>
<startPosition>sample string 7</startPosition>
<totalSetSize>sample string 5</totalSetSize>
</externalFolder>