Chilkat Online Tools

Python / DocuSign eSignature REST API / Gets a list of the folders for the account.

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()

queryParams = chilkat.CkJsonObject()
queryParams.UpdateString("include","{{include}}")
queryParams.UpdateString("include_items","{{include_items}}")
queryParams.UpdateString("start_position","{{start_position}}")
queryParams.UpdateString("template","{{template}}")
queryParams.UpdateString("user_filter","{{user_filter}}")

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

# resp is a CkHttpResponse
resp = http.QuickRequestParams("GET","https://domain.com/v2.1/accounts/{{accountId}}/folders",queryParams)
if (http.get_LastMethodSuccess() == False):
    print(http.lastErrorText())
    sys.exit()

print(str(resp.get_StatusCode()))
print(resp.bodyStr())

Curl Command

curl -G -d "include=%7B%7Binclude%7D%7D"
	-d "include_items=%7B%7Binclude_items%7D%7D"
	-d "start_position=%7B%7Bstart_position%7D%7D"
	-d "template=%7B%7Btemplate%7D%7D"
	-d "user_filter=%7B%7Buser_filter%7D%7D"
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
https://domain.com/v2.1/accounts/{{accountId}}/folders

Postman Collection Item JSON

{
  "name": "Gets a list of the folders for the account.",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/folders?include={{include}}&include_items={{include_items}}&start_position={{start_position}}&template={{template}}&user_filter={{user_filter}}",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "folders"
      ],
      "query": [
        {
          "key": "include",
          "value": "{{include}}"
        },
        {
          "key": "include_items",
          "value": "{{include_items}}"
        },
        {
          "key": "start_position",
          "value": "{{start_position}}"
        },
        {
          "key": "template",
          "value": "{{template}}"
        },
        {
          "key": "user_filter",
          "value": "{{user_filter}}"
        }
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}",
          "type": "string"
        }
      ]
    },
    "description": "Retrieves a list of the folders for the account, including the folder hierarchy. You can specify whether to return just the template folder or template folder and normal folders by setting the `template` query string parameter."
  },
  "response": [
  ]
}