DocuSign: Returns a list of bulk send batch summaries
DocuSign esignature.esignatureBulkSendV2BatchGetBulkSendBatches: arguments, response, policy and SDK examples.
← Esignature operations · Get started
Operation docusign.esignature_bulksendv2batch_getbulksendbatches
Provider route: GET /restapi/v2.1/accounts/{accountId}/bulk_send_batch. 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"]["esignatureBulkSendV2BatchGetBulkSendBatches"]>[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.esignatureBulkSendV2BatchGetBulkSendBatches(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_bulk_send_v2_batch_get_bulk_send_batches(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 | |
query | object | Optional | Additional keys: not allowed |
query.batch_ids | string | Optional | |
query.count | string | Optional | |
query.from_date | string | Optional | |
query.search_text | string | Optional | |
query.start_position | string | Optional | |
query.status | string | Optional | |
query.to_date | string | Optional | |
query.user_id | 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 Returns a list of bulk send batch summaries — response body |
Referenced models: Returns a list of bulk send batch summaries — response body
Schemas
Section titled “Schemas”Returns a list of bulk send batch summaries — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A list of bulk send batch summaries. |
batchSizeLimit | string | Optional | The maximum number of envelopes the account is permitted to submit in a given batch. |
bulkBatchSummaries | array | Optional | An array of batch summaries. |
bulkBatchSummaries[] | Model | Each item | Expand Returns a list of bulk send batch summaries — response body — bulk Batch Summaries item |
bulkProcessQueueLimit | string | Optional | |
bulkProcessTotalQueued | string | Optional | |
endPosition | string | Optional | The last index position in the result set. |
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. |
queueLimit | string | Optional | Maximum number of envelopes an account is permitted to have in the queue at any one time. |
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`. |
startPosition | string | Optional | The starting index position of the current result set. |
totalQueued | string | Optional | The number of envelopes currently pending processing for the entire account. |
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: Returns a list of bulk send batch summaries — response body — bulk Batch Summaries item
Returns a list of bulk send batch summaries — response body — bulk Batch Summaries item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Summary status of a single batch. |
action | string | Optional | |
actionStatus | string | Optional | |
batchId | string | Optional | The batch ID. |
batchName | string | Optional | The name of the batch. |
batchSize | string | Optional | The number of envelopes in the batch. |
batchUri | string | Optional | The batch details URI. |
failed | string | Optional | Number of envelopes that failed to send. |
queued | string | Optional | Number of envelopes peding processing. |
sent | string | Optional | Number of envelopes that have been sent. |
submittedDate | string | Optional | The time stamp of when the batch was created in ISO 8601 format. |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: docusign.esignature_bulksendv2batch_getbulksendbatches. Catalog operation: esignature:BulkSendV2Batch_GetBulkSendBatches. 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.