Dropbox Sign Developer Documentation

import json
from datetime import date, datetime
from pprint import pprint
from dropbox_sign import ApiClient, ApiException, Configuration, api, models
configuration = Configuration(
    username="YOUR_API_KEY",
    # access_token="YOUR_ACCESS_TOKEN",
)
with ApiClient(configuration) as api_client:
    try:
        response = api.BulkSendJobApi(api_client).bulk_send_job_get(
            bulk_send_job_id="6e683bc0369ba3d5b6f43c2c22a8031dbf6bd174",
            page=1,
            page_size=20,
        )
        pprint(response)
    except ApiException as e:
        print("Exception when calling BulkSendJobApi#bulk_send_job_get: %s\n" % e)

{
  "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",
          "name": "Needs Express Shipping",
          "signature_id": "78caf2a1d01cd39cea2bc1cbb340dac3"
        },
        {
          "type": "text",
          "api_id": "80c678_2",
          "name": "Shipping Address",
          "signature_id": "78caf2a1d01cd39cea2bc1cbb340dac3"
        },
        {
          "type": "text",
          "api_id": "80c678_3",
          "name": "DateSigned",
          "signature_id": "78caf2a1d01cd39cea2bc1cbb340dac3"
        }
      ],
      "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

Basic authentication of the form Basic <username:password>.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

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 or null

A list of warnings.

Get Bulk Send Job

Authentication

Path parameters

Query parameters

Response headers

Response

Errors