Chilkat Online Tools

PowerBuilder / DocuSign eSignature REST API / Gets a list of envelopes in folders matching the specified criteria.

Back to Collection Items

integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_QueryParams
oleobject loo_Resp

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

loo_Http = create oleobject
// Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
li_rc = loo_Http.ConnectToNewObject("Chilkat.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

loo_QueryParams = create oleobject
// Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
li_rc = loo_QueryParams.ConnectToNewObject("Chilkat.JsonObject")

loo_QueryParams.UpdateString("all","{{all}}")
loo_QueryParams.UpdateString("count","{{count}}")
loo_QueryParams.UpdateString("from_date","{{from_date}}")
loo_QueryParams.UpdateString("include_recipients","{{include_recipients}}")
loo_QueryParams.UpdateString("order","{{order}}")
loo_QueryParams.UpdateString("order_by","{{order_by}}")
loo_QueryParams.UpdateString("start_position","{{start_position}}")
loo_QueryParams.UpdateString("to_date","{{to_date}}")

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

loo_Resp = loo_Http.QuickRequestParams("GET","https://domain.com/v2.1/accounts/{{accountId}}/search_folders/{{searchFolderId}}",loo_QueryParams)
if loo_Http.LastMethodSuccess = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_QueryParams
    return
end if

Write-Debug string(loo_Resp.StatusCode)
Write-Debug loo_Resp.BodyStr
destroy loo_Resp


destroy loo_Http
destroy loo_QueryParams

Curl Command

curl -G -d "all=%7B%7Ball%7D%7D"
	-d "count=%7B%7Bcount%7D%7D"
	-d "from_date=%7B%7Bfrom_date%7D%7D"
	-d "include_recipients=%7B%7Binclude_recipients%7D%7D"
	-d "order=%7B%7Border%7D%7D"
	-d "order_by=%7B%7Border_by%7D%7D"
	-d "start_position=%7B%7Bstart_position%7D%7D"
	-d "to_date=%7B%7Bto_date%7D%7D"
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
https://domain.com/v2.1/accounts/{{accountId}}/search_folders/{{searchFolderId}}

Postman Collection Item JSON

{
  "name": "Gets a list of envelopes in folders matching the specified criteria.",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/search_folders/{{searchFolderId}}?all={{all}}&count={{count}}&from_date={{from_date}}&include_recipients={{include_recipients}}&order={{order}}&order_by={{order_by}}&start_position={{start_position}}&to_date={{to_date}}",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "search_folders",
        "{{searchFolderId}}"
      ],
      "query": [
        {
          "key": "all",
          "value": "{{all}}"
        },
        {
          "key": "count",
          "value": "{{count}}"
        },
        {
          "key": "from_date",
          "value": "{{from_date}}"
        },
        {
          "key": "include_recipients",
          "value": "{{include_recipients}}"
        },
        {
          "key": "order",
          "value": "{{order}}"
        },
        {
          "key": "order_by",
          "value": "{{order_by}}"
        },
        {
          "key": "start_position",
          "value": "{{start_position}}"
        },
        {
          "key": "to_date",
          "value": "{{to_date}}"
        }
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}",
          "type": "string"
        },
        {
          "key": "searchFolderId",
          "value": "{{searchFolderId}}",
          "type": "string"
        }
      ]
    },
    "description": "Retrieves a list of envelopes that match the criteria specified in the query.\n\nIf the user ID of the user making the call is the same as the user ID for any returned recipient, then the userId property is added to the returned information for those recipients."
  },
  "response": [
  ]
}