DocuSign: Retrieves a list of all the items in a specified folder from the specified cloud storage provider
DocuSign esignature.esignatureCloudStorageFolderGetCloudStorageFolderAll: arguments, response, policy and SDK examples.
← Esignature operations · Get started
Operation docusign.esignature_cloudstoragefolder_getcloudstoragefolderall
Provider route: GET /restapi/v2.1/accounts/{accountId}/users/{userId}/cloud_storage/{serviceId}/folders. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”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"]["esignatureCloudStorageFolderGetCloudStorageFolderAll"]>[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.esignatureCloudStorageFolderGetCloudStorageFolderAll(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom 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_all(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.accountId | string | Required within parent | |
path.serviceId | string | Required within parent | |
path.userId | string | Required within parent | |
query | object | Optional | Additional keys: not allowed |
query.cloud_storage_folder_path | string | Optional | |
query.count | string | Optional | |
query.order | string | Optional | |
query.order_by | string | Optional | |
query.search_text | string | Optional | |
query.start_position | string | Optional |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand 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
Schemas
Section titled “Schemas”Gets a list of items from a cloud storage provider — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
endPosition | string | Optional | The last index position in the result set. |
errorDetails | Model | Optional | Expand 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. |
id | string | Optional | A unique ID for the Salesforce object. |
items | array | Optional | If the tab is a list, this represents the values that are possible for the tab. |
items[] | Model | Each item | Expand Gets a list of items from a cloud storage provider — response body — items item |
name | string | Optional | |
nextUri | string | Optional | 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 | Optional | 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 | Optional | The 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`. |
skyDriveSkipToken | string | Optional | |
startPosition | string | Optional | The starting index position of the current result set. |
totalSetSize | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
authenticationUrl | string | Optional | Reserved for Docusign. |
errorCode | string | Optional | A code associated with the error condition. |
message | string | Optional |
Gets a list of items from a cloud storage provider — response body — items item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | This object contains information about a file or folder in cloud storage. |
date | string | Optional | The UTC date and time that the file or folder was last modified. |
hasCompositeTemplate | string | Optional | |
id | string | Optional | The storage provider's ID for the file or folder. |
img | string | Optional | The file extension for a file. **Note:** If the item is a folder, this value is null. |
name | string | Optional | The full name of a file. |
ownerName | string | Optional | |
size | string | Optional | The size of the file. The file size limit varies based on the cloud storage provider. |
supported | string | Optional | When **true,** Docusign supports the file type for upload. |
type | string | Optional | The type of cloud storage item. Valid values are: - `file` - `folder` |
uri | string | Optional | The URI for the file or folder. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: docusign.esignature_cloudstoragefolder_getcloudstoragefolderall. Catalog operation: esignature:CloudStorageFolder_GetCloudStorageFolderAll. 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.