Skip to content

DocuSign: Gets a list of items from a cloud storage provider

DocuSign esignature.esignatureCloudStorageFolderGetCloudStorageFolder: arguments, response, policy and SDK examples.

← Esignature operations · Get started

Operation docusign.esignature_cloudstoragefolder_getcloudstoragefolder

Provider route: GET /restapi/v2.1/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}/folders/{folderId}. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/docusign with npm, or alter-sdk-docusign with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { DocuSignIntegration } from "@alter-ai/docusign";
async function execute(input: Parameters<DocuSignIntegration["esignature"]["esignatureCloudStorageFolderGetCloudStorageFolder"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new DocuSignIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.esignature.esignatureCloudStorageFolderGetCloudStorageFolder(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_docusign import DocuSignIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = DocuSignIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.esignature.esignature_cloud_storage_folder_get_cloud_storage_folder(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.accountIdstringRequired within parent
path.folderIdstringRequired within parent
path.serviceIdstringRequired within parent
path.userIdstringRequired within parent
queryobjectOptionalAdditional keys: not allowed
query.cloud_storage_folder_pathstringOptional
query.cloud_storage_folderid_plainstringOptional
query.countstringOptional
query.orderstringOptional
query.order_bystringOptional
query.search_textstringOptional
query.sky_drive_skip_tokenstringOptional
query.start_positionstringOptional

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Gets a list of items from a cloud storage provider — response body

Referenced models: Gets a list of items from a cloud storage provider — response body

Gets a list of items from a cloud storage provider — response body
FieldTypePresenceDescription and constraints
$objectRoot
endPositionstringOptionalThe last index position in the result set.
errorDetailsModelOptionalExpand Gets a list of items from a cloud storage provider — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
idstringOptionalA unique ID for the Salesforce object.
itemsarrayOptionalIf the tab is a list, this represents the values that are possible for the tab.
items[]ModelEach itemExpand Gets a list of items from a cloud storage provider — response body — items item
namestringOptional
nextUristringOptionalThe 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.
previousUristringOptionalThe 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.
resultSetSizestringOptionalThe number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`.
skyDriveSkipTokenstringOptional
startPositionstringOptionalThe starting index position of the current result set.
totalSetSizestringOptionalThe total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.

Referenced models: Gets a list of items from a cloud storage provider — response body — error Details, Gets a list of items from a cloud storage provider — response body — items item

Gets a list of items from a cloud storage provider — response body — error Details
FieldTypePresenceDescription and constraints
$objectRoot
authenticationUrlstringOptionalReserved for Docusign.
errorCodestringOptionalA code associated with the error condition.
messagestringOptional
Gets a list of items from a cloud storage provider — response body — items item
FieldTypePresenceDescription and constraints
$objectRootThis object contains information about a file or folder in cloud storage.
datestringOptionalThe UTC date and time that the file or folder was last modified.
hasCompositeTemplatestringOptional
idstringOptionalThe storage provider's ID for the file or folder.
imgstringOptionalThe file extension for a file.

**Note:** If the item is a folder, this value is null.
namestringOptionalThe full name of a file.
ownerNamestringOptional
sizestringOptionalThe size of the file. The file size limit varies based on the cloud storage provider.
supportedstringOptionalWhen **true,** Docusign supports the file type for upload.
typestringOptionalThe type of cloud storage item. Valid values are:

- `file`
- `folder`
uristringOptionalThe URI for the file or folder.

SDK function policy ID: docusign.esignature_cloudstoragefolder_getcloudstoragefolder. Catalog operation: esignature:CloudStorageFolder_GetCloudStorageFolder. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.