List Signature Requests

get/signature_request/list

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.

Securityapi_key or oauth2
Request
query Parameters
account_id
string

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

page
integer
Default: 1

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

Example: page=1
page_size
integer
Default: 20

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

query
string

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

Responses
200

successful operation

4XX

failed_operation

Request samples 
<?php

namespace Dropbox\SignSandbox;

require_once __DIR__ . '/../vendor/autoload.php';

use SplFileObject;
use Dropbox;

$config = Dropbox\Sign\Configuration::getDefaultConfiguration();
$config->setUsername("YOUR_API_KEY");
// $config->setAccessToken("YOUR_ACCESS_TOKEN");

try {
    $response = (new Dropbox\Sign\Api\SignatureRequestApi(config: $config))->signatureRequestList(
        page: 1,
        page_size: 20,
    );

    print_r($response);
} catch (Dropbox\Sign\ApiException $e) {
    echo "Exception when calling SignatureRequestApi#signatureRequestList: {$e->getMessage()}";
}
Response samples
application/json
{
  • "list_info": {
    },
  • "signature_requests": [
    ]
}