Skip to content

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.

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 os
from alter_sdk import App
from 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()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.accountIdstringRequired within parent
queryobjectOptionalAdditional keys: not allowed
query.batch_idsstringOptional
query.countstringOptional
query.from_datestringOptional
query.search_textstringOptional
query.start_positionstringOptional
query.statusstringOptional
query.to_datestringOptional
query.user_idstringOptional

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Returns a list of bulk send batch summaries — response body

Referenced models: Returns a list of bulk send batch summaries — response body

Returns a list of bulk send batch summaries — response body
FieldTypePresenceDescription and constraints
$objectRootA list of bulk send batch summaries.
batchSizeLimitstringOptionalThe maximum number of envelopes the account is permitted to submit in a given batch.
bulkBatchSummariesarrayOptionalAn array of batch summaries.
bulkBatchSummaries[]ModelEach itemExpand Returns a list of bulk send batch summaries — response body — bulk Batch Summaries item
bulkProcessQueueLimitstringOptional
bulkProcessTotalQueuedstringOptional
endPositionstringOptionalThe last index position in the result set.
nextUristringOptionalThe 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.
previousUristringOptionalThe 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.
queueLimitstringOptionalMaximum number of envelopes an account is permitted to have in the queue at any one time.
resultSetSizestringOptionalThe 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`.
startPositionstringOptionalThe starting index position of the current result set.
totalQueuedstringOptionalThe number of envelopes currently pending processing for the entire account.
totalSetSizestringOptionalThe 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
FieldTypePresenceDescription and constraints
$objectRootSummary status of a single batch.
actionstringOptional
actionStatusstringOptional
batchIdstringOptionalThe batch ID.
batchNamestringOptionalThe name of the batch.
batchSizestringOptionalThe number of envelopes in the batch.
batchUristringOptionalThe batch details URI.
failedstringOptionalNumber of envelopes that failed to send.
queuedstringOptionalNumber of envelopes peding processing.
sentstringOptionalNumber of envelopes that have been sent.
submittedDatestringOptionalThe time stamp of when the batch was created in ISO 8601 format.

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.

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.