Chilkat Online Tools

Powershell / DocuSign REST API / Gets the status of recipients for an envelope.

Back to Collection Items

Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"

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

$http = New-Object Chilkat.Http

$queryParams = New-Object Chilkat.JsonObject
$queryParams.UpdateString("include_anchor_tab_locations","{{include_anchor_tab_locations}}")
$queryParams.UpdateString("include_extended","{{include_extended}}")
$queryParams.UpdateString("include_metadata","{{include_metadata}}")
$queryParams.UpdateString("include_tabs","{{include_tabs}}")

# Adds the "Authorization: Bearer {{accessToken}}" header.
$http.AuthToken = "{{accessToken}}"
$http.SetRequestHeader("Accept","application/json")

$resp = $http.QuickRequestParams("GET","https://domain.com/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/recipients",$queryParams)
if ($http.LastMethodSuccess -eq $false) {
    $($http.LastErrorText)
    exit
}

$($resp.StatusCode)
$($resp.BodyStr)

Curl Command

curl -G -d "include_anchor_tab_locations=%7B%7Binclude_anchor_tab_locations%7D%7D"
	-d "include_extended=%7B%7Binclude_extended%7D%7D"
	-d "include_metadata=%7B%7Binclude_metadata%7D%7D"
	-d "include_tabs=%7B%7Binclude_tabs%7D%7D"
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
https://domain.com/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/recipients

Postman Collection Item JSON

{
  "name": "Gets the status of recipients for an envelope.",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/recipients?include_anchor_tab_locations={{include_anchor_tab_locations}}&include_extended={{include_extended}}&include_metadata={{include_metadata}}&include_tabs={{include_tabs}}",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "envelopes",
        "{{envelopeId}}",
        "recipients"
      ],
      "query": [
        {
          "key": "include_anchor_tab_locations",
          "value": "{{include_anchor_tab_locations}}"
        },
        {
          "key": "include_extended",
          "value": "{{include_extended}}"
        },
        {
          "key": "include_metadata",
          "value": "{{include_metadata}}"
        },
        {
          "key": "include_tabs",
          "value": "{{include_tabs}}"
        }
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}"
        },
        {
          "key": "envelopeId",
          "value": "{{envelopeId}}"
        }
      ]
    },
    "description": "Retrieves the status of all recipients in a single envelope and identifies the current recipient in the routing list. \n\nThe `currentRoutingOrder` property of the response contains the `routingOrder` value of the current recipient indicating that the envelope has been sent to the recipient, but the recipient has not completed their actions."
  },
  "response": [
  ]
}