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

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

$config = HelloSignSDK\Configuration::getDefaultConfiguration();

// Configure HTTP basic authorization: api_key
$config->setUsername("YOUR_API_KEY");

// or, configure Bearer (JWT) authorization: oauth2
// $config->setAccessToken("YOUR_ACCESS_TOKEN");

$api = new HelloSignSDK\Api\SignatureRequestApi($config);

$accountId = null;
$page = 1;

try {
    $result = $api->signatureRequestList($accountId, $page);
    print_r($result);
} catch (HelloSignSDK\ApiException $e) {
    $error = $e->getResponseObject();
    echo "Exception when calling HelloSign API: "
        . print_r($error->getError());
}
Response samples
application/json
{
  • "list_info": {
    },
  • "signature_requests": [
    ]
}