Chilkat Online Tools

Perl / DocuSign Click API / 4. Envelope Recipients

Back to Collection Items

use chilkat();

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

$http = chilkat::CkHttp->new();

# Adds the "Authorization: Bearer {{accessToken}}" header.
$http->put_AuthToken("{{accessToken}}");

$sbResponseBody = chilkat::CkStringBuilder->new();
$success = $http->QuickGetSb("https://domain.com/{{apiVersion}}/accounts/{{accountId}}/envelopes/{{envelopeId}}/recipients",$sbResponseBody);
if ($success == 0) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

print "Response status code = " . $http->get_LastStatus() . "\r\n";
print $sbResponseBody->getAsString() . "\r\n";

Curl Command

curl -X GET
	-H "Authorization: Bearer {{accessToken}}"
https://domain.com/{{apiVersion}}/accounts/{{accountId}}/envelopes/{{envelopeId}}/recipients

Postman Collection Item JSON

{
  "name": "4. Envelope Recipients",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/{{apiVersion}}/accounts/{{accountId}}/envelopes/{{envelopeId}}/recipients",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "{{apiVersion}}",
        "accounts",
        "{{accountId}}",
        "envelopes",
        "{{envelopeId}}",
        "recipients"
      ]
    },
    "description": "In this example, we will list the recipents of an envelope. This endpoint is particularly useful if the envelope is in `draft` stage and we want to make changes to its recipents before sending."
  },
  "response": [
  ]
}