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.SignatureRequestApi(api_client).signature_request_list(
            page=1,
            page_size=20,
        )
        pprint(response)
    except ApiException as e:
        print("Exception when calling SignatureRequestApi#signature_request_list: %s\n" % e)

{
  "signature_requests": [
    {
      "signature_request_id": "d10338cad145e1cb68afc828",
      "requester_email_address": "me@dropboxsign.com",
      "title": "FHA",
      "original_title": "FHA",
      "subject": "FHA",
      "message": "Let me know if you two have any questions.",
      "metadata": {},
      "created_at": 1570471067,
      "is_complete": false,
      "is_declined": false,
      "has_error": false,
      "signing_url": "https://app.hellosign.com/sign/d10338cad145e1cb68afc828",
      "details_url": "https://app.hellosign.com/home/manage?guid=d10338cad145e1cb68afc828",
      "cc_email_addresses": [
        "stan@example.com"
      ],
      "signing_redirect_url": null,
      "custom_fields": [],
      "response_data": [],
      "signatures": [
        {
          "signature_id": "78caf2a1d01cd39cea2bc1cbb340dac3",
          "signer_email_address": "george-jetson@example.com",
          "signer_name": "George Jetson",
          "signer_role": null,
          "order": 0,
          "status_code": "awaiting_signature",
          "signed_at": null,
          "last_viewed_at": null,
          "last_reminded_at": null,
          "has_pin": false,
          "has_sms_auth": false
        },
        {
          "signature_id": "616629ed37f8588d28600be17ab5d6b7",
          "signer_email_address": "jane-jetson@example.com",
          "signer_name": "Jane Jetson",
          "signer_role": null,
          "order": 1,
          "status_code": "awaiting_signature",
          "signed_at": null,
          "last_viewed_at": null,
          "last_reminded_at": null,
          "has_pin": false,
          "has_sms_auth": false
        }
      ]
    },
    {
      "signature_request_id": "fa5c8a0b0f492d768749333a",
      "requester_email_address": "me@dropboxsign.com",
      "title": "Purchase Agreement",
      "original_title": "Purchase Agreement",
      "subject": "Purchase Agreement",
      "message": "Please sign and return.",
      "metadata": {},
      "is_complete": true,
      "is_declined": false,
      "has_error": false,
      "signing_url": null,
      "details_url": "https://app.hellosign.com/home/manage?guid=fa5c8a0b0f492d768749333a",
      "cc_email_addresses": [],
      "signing_redirect_url": null,
      "custom_fields": [],
      "response_data": [
        {
          "type": "checkbox",
          "api_id": "uniqueIdHere_1",
          "name": "Needs Express Shipping",
          "signature_id": "5687fb7bd5aaacb1689728762b600c74"
        },
        {
          "type": "text",
          "api_id": "uniqueIdHere_2",
          "name": "Shipping Address",
          "signature_id": "5687fb7bd5aaacb1689728762b600c74"
        },
        {
          "type": "date_signed",
          "api_id": "uniqueIdHere_3",
          "name": "DateSigned",
          "signature_id": "5687fb7bd5aaacb1689728762b600c74"
        }
      ],
      "signatures": [
        {
          "signature_id": "5687fb7bd5aaacb1689728762b600c74",
          "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
        }
      ]
    }
  ],
  "list_info": {
    "num_pages": 1,
    "num_results": 2,
    "page": 1,
    "page_size": 20
  }
}

Returns a list of SignatureRequests that you can access. This includes SignatureRequests you have sent as well as received, but not ones that you have been CCed on.

Take a look at our search guide to learn more about querying signature requests.

Authentication

AuthorizationBasic

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

AuthorizationBearer

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

Query parameters

account_idstringOptional

Which account to return SignatureRequests for. Must be a team member. Use all to indicate all team members. Defaults to your account.

pageintegerOptionalDefaults to 1

Which page number of the SignatureRequest 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.

querystringOptional

String that includes search terms and/or fields to be used to filter the SignatureRequest objects.

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

signature_requestslist of objects

Contains information about signature requests.

list_infoobject

Contains pagination information about the data returned.

warningslist of objects or null

A list of warnings.

List Signature Requests

Authentication

Query parameters

Response headers

Response

Errors