docusign.bulk-send.get-bulk-send-batch-envelopes

This method returns a list of envelopes in a specified bulk batch. Use the query parameters to filter and sort the envelopes by different attributes.

Gets envelopes from a specific bulk send batch.

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.
bulksendbatchid	string	Yes	—	The batch ID.
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 1000
include	string	No	—	When recipients, only envelopes with recipient nodes will be included in the response.
order	string	No	—	The order in which to sort the results. Valid values are: - Descending order: desc (default) - Ascending order: asc
order_by	string	No	—	The envelope attribute used to sort the results. Valid values are: - created (default) - completed - last_modified - sent - status - subject - status_changed
search_text	string	No	—	Use this parameter to search for specific text.
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.
status	string	No	—	Comma-separated list of envelope statuses. Note that any should not be included with other statuses. In other words, any is a valid parameter value, but any,sent is not. Use the value deliveryfailure to get all envelopes with AuthFailed and AutoResponded status. This value is specific to bulk sending.

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.
bulksendbatchid	string	Yes	—	The batch ID.
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 1000
include	string	No	—	When recipients, only envelopes with recipient nodes will be included in the response.
order	string	No	—	The order in which to sort the results. Valid values are: - Descending order: desc (default) - Ascending order: asc
order_by	string	No	—	The envelope attribute used to sort the results. Valid values are: - created (default) - completed - last_modified - sent - status - subject - status_changed
search_text	string	No	—	Use this parameter to search for specific text.
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.
status	string	No	—	Comma-separated list of envelope statuses. Note that any should not be included with other statuses. In other words, any is a valid parameter value, but any,sent is not. Use the value deliveryfailure to get all envelopes with AuthFailed and AutoResponded status. This value is specific to bulk sending.
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}/bulk_send_batch/{bulkSendBatchId}/envelopes
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}/bulk_send_batch/{bulkSendBatchId}/envelopes
* (any state)	fail	failed	Record the failure reason

API Usage

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

{
  "workflow_type": "docusign.bulk-send.get-bulk-send-batch-envelopes",
  "initial_data": {
    "base_url": "value",
    "accountid": "value",
    "bulksendbatchid": "value"
  }
}