Chilkat Online Tools

Python / DocuSign REST API / 9. Lists the Documents in an Envelope

Back to Collection Items

import sys
import chilkat

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

http = chilkat.CkHttp()

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

sbResponseBody = chilkat.CkStringBuilder()
success = http.QuickGetSb("https://domain.com/{{apiVersion}}/accounts/{{accountId}}/envelopes/{{envelopeId}}/documents",sbResponseBody)
if (success == False):
    print(http.lastErrorText())
    sys.exit()

print("Response status code = " + str(http.get_LastStatus()))
print(sbResponseBody.getAsString())

Curl Command

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

Postman Collection Item JSON

{
  "name": "9. Lists the Documents in an Envelope",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/{{apiVersion}}/accounts/{{accountId}}/envelopes/{{envelopeId}}/documents",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "{{apiVersion}}",
        "accounts",
        "{{accountId}}",
        "envelopes",
        "{{envelopeId}}",
        "documents"
      ]
    },
    "description": "In this example, we will list all the documents that are included in an envelope."
  },
  "response": [
  ]
}