Chilkat Online Tools

Ruby / PandaDoc API Reference / List Documents Folders

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

http.SetRequestHeader("Authorization","API-Key {{api_key}}")

sbResponseBody = Chilkat::CkStringBuilder.new()
success = http.QuickGetSb("https://api.pandadoc.com/public/v1/documents/folders",sbResponseBody)
if (success == false)
    print http.lastErrorText() + "\n";
    exit
end

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = http.get_LastStatus()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print http.lastHeader() + "\n";
    print "Failed." + "\n";
    exit
end

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "count": 0,
#   "next": null,
#   "previous": null,
#   "results": [
#   ]
# }

# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

count = jResp.IntOf("count")
v_next = jResp.stringOf("next")
previous = jResp.stringOf("previous")
i = 0
count_i = jResp.SizeOfArray("results")
while i < count_i
    jResp.put_I(i)
    i = i + 1
end

Curl Command

curl -X GET
	-H "Authorization: Bearer {{access_token}}"
	-H "Authorization: API-Key {{api_key}}"
https://api.pandadoc.com/public/v1/documents/folders

Postman Collection Item JSON

{
  "name": "List Documents Folders",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Authorization",
        "value": "Bearer {{access_token}}",
        "disabled": true
      },
      {
        "key": "Authorization",
        "type": "text",
        "value": "API-Key {{api_key}}"
      }
    ],
    "url": {
      "raw": "https://api.pandadoc.com/public/v1/documents/folders",
      "protocol": "https",
      "host": [
        "api",
        "pandadoc",
        "com"
      ],
      "path": [
        "public",
        "v1",
        "documents",
        "folders"
      ]
    },
    "description": "For details go to https://developers.pandadoc.com/reference#list-documents-folders"
  },
  "response": [
    {
      "name": "Empty Response",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Authorization",
            "value": "Bearer {{access_token}}"
          },
          {
            "key": "Content-Type",
            "value": "application/json;charset=UTF-8",
            "description": "The mime type of this content"
          }
        ],
        "url": {
          "raw": "https://api.pandadoc.com/public/v1/templates",
          "protocol": "https",
          "host": [
            "api",
            "pandadoc",
            "com"
          ],
          "path": [
            "public",
            "v1",
            "templates"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "javascript",
      "header": [
        {
          "key": "Allow",
          "value": "GET, DELETE, HEAD, OPTIONS",
          "name": "Allow",
          "description": "Valid actions for a specified resource. To be used for a 405 Method not allowed"
        },
        {
          "key": "Cache-Control",
          "value": "no-cache",
          "name": "Cache-Control",
          "description": "Tells all caching mechanisms from server to client whether they may cache this object. It is measured in seconds"
        },
        {
          "key": "Connection",
          "value": "keep-alive",
          "name": "Connection",
          "description": "Options that are desired for the connection"
        },
        {
          "key": "Content-Encoding",
          "value": "gzip",
          "name": "Content-Encoding",
          "description": "The type of encoding used on the data."
        },
        {
          "key": "Content-Type",
          "value": "application/json",
          "name": "Content-Type",
          "description": "The mime type of this content"
        },
        {
          "key": "Date",
          "value": "Mon, 22 Aug 2016 17:01:13 GMT",
          "name": "Date",
          "description": "The date and time that the message was sent"
        },
        {
          "key": "Expires",
          "value": "Mon, 22 Aug 2016 17:01:12 GMT",
          "name": "Expires",
          "description": "Gives the date/time after which the response is considered stale"
        },
        {
          "key": "Pragma",
          "value": "no-cache",
          "name": "Pragma",
          "description": "Implementation-specific headers that may have various effects anywhere along the request-response chain."
        },
        {
          "key": "Server",
          "value": "nginx/1.4.6 (Ubuntu)",
          "name": "Server",
          "description": "A name for the server"
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked",
          "name": "Transfer-Encoding",
          "description": "The form of encoding used to safely transfer the entity to the user. Currently defined methods are: chunked, compress, deflate, gzip, identity."
        }
      ],
      "cookie": [
      ],
      "body": "{\"count\": 0, \"next\": null, \"previous\": null, \"results\": []}"
    }
  ]
}