Dropbox Sign Developer Documentation

curl -X GET 'https://api.hellosign.com/v3/bulk_send_job/{bulk_send_job_id}' \
  -u 'YOUR_API_KEY:'

{
  "bulk_send_job": {
    "bulk_send_job_id": "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174",
    "total": 1,
    "is_creator": true,
    "created_at": 1532640962
  },
  "list_info": {
    "num_pages": 1,
    "num_results": 1,
    "page": 1,
    "page_size": 20
  },
  "signature_requests": [
    {
      "bulk_send_job_id": "6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174",
      "cc_email_addresses": [],
      "custom_fields": [],
      "details_url": "https://app.hellosign.com/home/manage?guid=fa5c8a0b0f492d768749333ad6fcc214c111e967",
      "has_error": false,
      "is_complete": true,
      "is_declined": false,
      "message": "Please sign and return.",
      "requester_email_address": "me@dropboxsign.com",
      "response_data": [
        {
          "type": "checkbox",
          "api_id": "80c678_1",
          "signature_id": "78caf2a1d01cd39cea2bc1cbb340dac3",
          "name": "Needs Express Shipping",
          "value": true
        },
        {
          "type": "text",
          "api_id": "80c678_2",
          "signature_id": "78caf2a1d01cd39cea2bc1cbb340dac3",
          "name": "Shipping Address",
          "value": "1212 Park Avenue"
        },
        {
          "type": "text",
          "api_id": "80c678_3",
          "signature_id": "78caf2a1d01cd39cea2bc1cbb340dac3",
          "name": "DateSigned",
          "value": "09/01/2012"
        }
      ],
      "signature_request_id": "fa5c8a0b0f492d768749333ad6fcc214c111e967",
      "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
        }
      ],
      "signing_redirect_url": null,
      "signing_url": null,
      "subject": "Purchase Agreement",
      "title": "Purchase Agreement"
    }
  ]
}

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

Authentication

AuthorizationBasic

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).

AuthorizationBearer

You can use an Access Token issued through an OAuth flow to send calls to the Dropbox Sign API from your app. The access scopes required by this endpoint are listed in the gray box above. See Authentication for more information. ❌ Not supported by Try it console.

You can use an Access Token issued through an OAuth flow to send calls to the Dropbox Sign API from your app. The access scopes required by this endpoint are listed in the gray box above. See [Authentication](/api/reference/authentication) for more information. ❌ **Not supported** by Try it console.

Path parameters

bulk_send_job_idstringRequired

The id of the BulkSendJob to retrieve.

Query parameters

pageintegerOptionalDefaults to 1

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

page_sizeintegerOptionalDefaults to 20

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

Response headers

X-RateLimit-Limitinteger

The maximum number of requests per hour that you can make.

X-RateLimit-Remaininginteger

The number of requests remaining in the current rate limit window.

X-Ratelimit-Resetinteger

The Unix time at which the rate limit will reset to its maximum.

Response

successful operation

bulk_send_jobobject

Contains information about the BulkSendJob such as when it was created and how many signature requests are queued.

list_infoobject

Contains pagination information about the data returned.

signature_requestslist of objects

Contains information about the Signature Requests sent in bulk.

warningslist of objects

A list of warnings.

Errors

4XX

Client Request Error