List Signature Requests
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.
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
Query Parameters
Which account to return SignatureRequests for. Must be a team member. Use all to indicate all team members. Defaults to your account.
Which page number of the SignatureRequest List to return. Defaults to 1.
1Number of objects to be returned per page. Must be between 1 and 100. Default is 20.
20String that includes search terms and/or fields to be used to filter the SignatureRequest objects.
Response Body
application/json
application/json
curl -X GET "https://example.com/signature_request/list"{ "list_info": { "page": 1, "num_pages": 1, "num_results": 2, "page_size": 20 }, "signature_requests": [ { "signature_request_id": "d10338cad145e1cb68afc828", "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, "custom_fields": [], "response_data": [], "signing_url": "https://app.hellosign.com/sign/d10338cad145e1cb68afc828", "signing_redirect_url": null, "details_url": "https://app.hellosign.com/home/manage?guid=d10338cad145e1cb68afc828", "requester_email_address": "me@dropboxsign.com", "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 } ], "cc_email_addresses": [ "stan@example.com" ] }, { "signature_request_id": "fa5c8a0b0f492d768749333a", "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, "custom_fields": [], "response_data": [ { "api_id": "uniqueIdHere_1", "name": "Needs Express Shipping", "signature_id": "5687fb7bd5aaacb1689728762b600c74", "value": true, "type": "checkbox" }, { "api_id": "uniqueIdHere_2", "name": "Shipping Address", "signature_id": "5687fb7bd5aaacb1689728762b600c74", "value": "1212 Park Avenue", "type": "text" }, { "api_id": "uniqueIdHere_3", "name": "DateSigned", "signature_id": "5687fb7bd5aaacb1689728762b600c74", "value": "09/01/2012", "type": "date_signed" } ], "signing_url": null, "signing_redirect_url": null, "details_url": "https://app.hellosign.com/home/manage?guid=fa5c8a0b0f492d768749333a", "requester_email_address": "me@dropboxsign.com", "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 } ], "cc_email_addresses": [] } ]}Get Signature Request GET
Returns the status of the SignatureRequest specified by the `signature_request_id` parameter.
Release On-Hold Signature Request POST
Releases a held SignatureRequest that was claimed and prepared from an [UnclaimedDraft](https://developers.hellosign.com/api/reference/tag/Unclaimed-Draft). The owner of the Draft must indicate at Draft creation that the SignatureRequest created from the Draft should be held. Releasing the SignatureRequest will send requests to all signers.