docusign.folders.get-search-folder-contents

<ds-inlinemessage kind="warning" markdown="1"> <strong>This method is deprecated in API v2.1</strong> Use Envelopes: listStatusChanges instead. </ds-inlinemessage> Retrieves a list of items that match the criteria specified in the query. If the user ID of the user making the call is the same as the user ID for any returned recipient, then the userId property is added to the returned information for those recipients.

Deprecated. Use Envelopes: listStatusChanges.

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.
searchfolderid	string	Yes	—	Specifies the envelope group that is searched by the request. These are logical groupings, not actual folder names. Valid values are: drafts, awaiting_my_signature, completed, out_for_signature.
all	string	No	—	Specifies that all envelopes that match the criteria are returned.
count	string	No	—	The maximum number of results to return. Use start_position to specify the number of results to skip. Valid values: 1 to 100
from_date	string	No	—	Specifies the start of the date range to return. If no value is provided, the default search is the previous 30 days.
include_recipients	string	No	—	When true, the recipient information is returned in the response.
order	string	No	—	Specifies the order in which the list is returned. Valid values are: asc for ascending order, and desc for descending order.
order_by	string	No	—	Specifies the property used to sort the list. Valid values are: action_required, created, completed, sent, signer_list, status, or subject.
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.
to_date	string	No	—	Specifies the end of the date range to return.

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.
searchfolderid	string	Yes	—	Specifies the envelope group that is searched by the request. These are logical groupings, not actual folder names. Valid values are: drafts, awaiting_my_signature, completed, out_for_signature.
all	string	No	—	Specifies that all envelopes that match the criteria are returned.
count	string	No	—	The maximum number of results to return. Use start_position to specify the number of results to skip. Valid values: 1 to 100
from_date	string	No	—	Specifies the start of the date range to return. If no value is provided, the default search is the previous 30 days.
include_recipients	string	No	—	When true, the recipient information is returned in the response.
order	string	No	—	Specifies the order in which the list is returned. Valid values are: asc for ascending order, and desc for descending order.
order_by	string	No	—	Specifies the property used to sort the list. Valid values are: action_required, created, completed, sent, signer_list, status, or subject.
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.
to_date	string	No	—	Specifies the end of the date range to return.
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}/search_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}/search_folders/
* (any state)	fail	failed	Record the failure reason

API Usage

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

{
  "workflow_type": "docusign.folders.get-search-folder-contents",
  "initial_data": {
    "base_url": "value",
    "accountid": "value",
    "searchfolderid": "value"
  }
}