docusign.workspace-items.get-workspace-folder

This method returns the contents of a workspace folder, which can include sub-folders and files.

List workspace folder contents

Overview

Property	Value
Workflow type	Atomic
Library	App-docusign
Version	1.0

Input Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Docusign API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
accountid	string	Yes	—	The external account number (int) or account ID GUID.
folderid	string	Yes	—	The ID of the folder.
workspaceid	string	Yes	—	The ID of the workspace.
count	string	No	—	The maximum number of results to return. Use start_position to specify the number of results to skip.
include_files	string	No	—	When true, the response includes file information (in addition to folder information). The default is false.
include_sub_folders	string	No	—	When true, the response includes information about the sub-folders of the current folder. The default is false.
include_thumbnails	string	No	—	When true, the response returns thumbnails. The default is false.
include_user_detail	string	No	—	When true, the response includes extended details about the user. The default is false.
start_position	string	No	—	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.
workspace_user_id	string	No	—	If set, the response only includes results associated with the userId that you specify.

Output Schema

Field	Type	Required	Default	Description
base_url	string	Yes	—	Docusign API root, e.g. https://<host>/api
api_token	string	No	—	Bearer token; omit to use the workflow's token env var
accountid	string	Yes	—	The external account number (int) or account ID GUID.
folderid	string	Yes	—	The ID of the folder.
workspaceid	string	Yes	—	The ID of the workspace.
count	string	No	—	The maximum number of results to return. Use start_position to specify the number of results to skip.
include_files	string	No	—	When true, the response includes file information (in addition to folder information). The default is false.
include_sub_folders	string	No	—	When true, the response includes information about the sub-folders of the current folder. The default is false.
include_thumbnails	string	No	—	When true, the response returns thumbnails. The default is false.
include_user_detail	string	No	—	When true, the response includes extended details about the user. The default is false.
start_position	string	No	—	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.
workspace_user_id	string	No	—	If set, the response only includes results associated with the userId that you specify.
status_code	integer	No	—	HTTP status code of the completed call
response	json	No	—	Parsed JSON response body
failure_reason	string	No	—	—
failure_type	string	No	—	—
failed_at	string	No	—	—
failed_step	string	No	—	—
failed_layer	string	No	—	—
failed_at_state	string	No	—	—
error	string	No	—	—
error_type	string	No	—	—

States

State	Initial	Terminal	Success	Auto-advance	Description
pending	Yes	No	—	execute	Waiting to call GET /v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/
completed	No	Yes	Yes	—	HTTP call succeeded
failed	No	Yes	No	—	HTTP call failed

State Diagram

Transitions

From	Action	To	Description
pending	execute	completed	Perform GET /v2.1/accounts/{accountId}/workspaces/{workspaceId}/folders/
* (any state)	fail	failed	Record the failure reason

API Usage

POST /api/workflows/start
Content-Type: application/json

{
  "workflow_type": "docusign.workspace-items.get-workspace-folder",
  "initial_data": {
    "base_url": "value",
    "accountid": "value",
    "folderid": "value",
    "workspaceid": "value"
  }
}