docusign.workspace-items.get-workspace-file

This method returns a binary version of a file in a workspace.

Gets a workspace file

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.
fileid	string	Yes	—	The ID of the file.
folderid	string	Yes	—	The ID of the folder.
workspaceid	string	Yes	—	The ID of the workspace.
is_download	string	No	—	When true, the Content-Disposition header is set in the response. The value of the header provides the filename of the file. The default is false.
pdf_version	string	No	—	When true the file is returned in PDF format.

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.
fileid	string	Yes	—	The ID of the file.
folderid	string	Yes	—	The ID of the folder.
workspaceid	string	Yes	—	The ID of the workspace.
is_download	string	No	—	When true, the Content-Disposition header is set in the response. The value of the header provides the filename of the file. The default is false.
pdf_version	string	No	—	When true the file is returned in PDF format.
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/{folderId}/files/
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/{folderId}/files/
* (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-file",
  "initial_data": {
    "base_url": "value",
    "accountid": "value",
    "fileid": "value",
    "folderid": "value"
  }
}