Chilkat Online Tools

Powershell / DocuSign REST API / 3. Get Envelope Status

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

# Adds the "Authorization: Bearer {{accessToken}}" header.
$http.AuthToken = "{{accessToken}}"

$sbResponseBody = New-Object Chilkat.StringBuilder
$success = $http.QuickGetSb("https://domain.com/{{apiVersion}}/accounts/{{accountId}}/envelopes/{{envelopeId}}",$sbResponseBody)
if ($success -eq $false) {
    $($http.LastErrorText)
    exit
}

$("Response status code = " + $http.LastStatus)
$($sbResponseBody.GetAsString())

Curl Command

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

Postman Collection Item JSON

{
  "name": "3. Get Envelope Status",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/{{apiVersion}}/accounts/{{accountId}}/envelopes/{{envelopeId}}",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "{{apiVersion}}",
        "accounts",
        "{{accountId}}",
        "envelopes",
        "{{envelopeId}}"
      ]
    },
    "description": "If one needs to check the status of an envelope, they can use this endpoint to retrieve the status."
  },
  "response": [
  ]
}