Bulk Send Job

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.

Authorization

AuthorizationBasic <token>

Your API key can be used to make calls to the Dropbox Sign API. See Authentication for more information. āœ… Supported by Try it console (calls sent in test_mode only).

In: header

Path Parameters

bulk_send_job_id*string

The id of the BulkSendJob to retrieve.

Query Parameters

page?integer

Which page number of the BulkSendJob list to return. Defaults to 1.

Default1
page_size?integer

Number of objects to be returned per page. Must be between 1 and 100. Default is 20.

Default20

Response Body

application/json

application/json

curl -X GET "https://example.com/bulk_send_job/6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174"
{  "bulk_send_job": {    "bulk_send_job_id": "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174",    "total": 1,    "is_creator": true,    "created_at": 1532640962  },  "list_info": {    "page": 1,    "num_pages": 1,    "num_results": 1,    "page_size": 20  },  "signature_requests": [    {      "signature_request_id": "fa5c8a0b0f492d768749333ad6fcc214c111e967",      "title": "Purchase Agreement",      "subject": "Purchase Agreement",      "message": "Please sign and return.",      "is_complete": true,      "is_declined": false,      "has_error": false,      "custom_fields": [],      "response_data": [        {          "api_id": "80c678_1",          "name": "Needs Express Shipping",          "signature_id": "78caf2a1d01cd39cea2bc1cbb340dac3",          "value": true,          "type": "checkbox"        },        {          "api_id": "80c678_2",          "name": "Shipping Address",          "signature_id": "78caf2a1d01cd39cea2bc1cbb340dac3",          "value": "1212 Park Avenue",          "type": "text"        },        {          "api_id": "80c678_3",          "name": "DateSigned",          "signature_id": "78caf2a1d01cd39cea2bc1cbb340dac3",          "value": "09/01/2012",          "type": "text"        }      ],      "signing_url": null,      "signing_redirect_url": null,      "details_url": "https://app.hellosign.com/home/manage?guid=fa5c8a0b0f492d768749333ad6fcc214c111e967",      "requester_email_address": "me@dropboxsign.com",      "signatures": [        {          "signature_id": "78caf2a1d01cd39cea2bc1cbb340dac3",          "signer_email_address": "john@example.com",          "signer_name": "John Doe",          "signer_role": null,          "order": null,          "status_code": "signed",          "signed_at": 1346521550,          "last_viewed_at": 1346521483,          "last_reminded_at": null,          "has_pin": false        }      ],      "cc_email_addresses": [],      "bulk_send_job_id": "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174"    }  ]}