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.

Manage accounts, signature requests, templates, teams, bulk sends, file downloads, fax, and event callbacks through the complete Dropbox Sign v3 API, including one-off debugging requests from the web Playground with the current session's credentials.

Request

operationId: signatureRequestList
Server: https://api.hellosign.com/v3
Authentication: api_key, oauth2

Request parameters

`account_id`

querystring

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

example-account-id

`page`

queryinteger

Which page number of the SignatureRequest List to return. Defaults to `1`.

`page_size`

queryinteger

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

`query`

querystring

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

Responses

`200`

SignatureRequestListResponseapplication/json

successful operation

Properties: signature_requestslist_infowarnings

`4XX`

ErrorResponseapplication/json

failed_operation

Properties: error

{
  "signature_requests": {
    "test_mode": false,
    "signature_request_id": "example-signature-request-id",
    "requester_email_address": "developer@example.com",
    "title": "Example document",
    "original_title": "Example document",
    "subject": "Example document",
    "message": "Example message",
    "metadata": {}
  },
  "list_info": {
    "num_pages": 0,
    "num_results": 0,
    "page": 0,
    "page_size": 0
  },
  "warnings": {
    "warning_name": "Example Name"
  }
}