Get Bulk Send Job

get/bulk_send_job/{bulk_send_job_id}

Returns the status of the BulkSendJob and its SignatureRequests specified by the bulk_send_job_id parameter.

Securityapi_key or oauth2
Request
path Parameters
bulk_send_job_id
required
string

The id of the BulkSendJob to retrieve.

Example: 6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174
Responses
200

successful operation

4XX

failed_operation

Request samples
<?php

require_once __DIR__ . "/vendor/autoload.php";

$config = HelloSignSDK\Configuration::getDefaultConfiguration();

// Configure HTTP basic authorization: api_key
$config->setUsername("YOUR_API_KEY");

// or, configure Bearer (JWT) authorization: oauth2
// $config->setAccessToken("YOUR_ACCESS_TOKEN");

$api = new HelloSignSDK\Api\BulkSendJobApi($config);

$bulkSendJobId = "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174";

try {
    $result = $api->bulkSendJobGet($bulkSendJobId);
    print_r($result);
} catch (HelloSignSDK\ApiException $e) {
    $error = $e->getResponseObject();
    echo "Exception when calling HelloSign API: "
        . print_r($error->getError());
}
Response samples
application/json
{
  • "bulk_send_job": {
    },
  • "list_info": {
    },
  • "signature_requests": [
    ]
}