Chilkat Online Tools

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

Back to Collection Items

var
http: HCkHttp;
success: Boolean;
queryParams: HCkJsonObject;
resp: HCkHttpResponse;

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

http := CkHttp_Create();

queryParams := CkJsonObject_Create();
CkJsonObject_UpdateString(queryParams,'all','{{all}}');
CkJsonObject_UpdateString(queryParams,'count','{{count}}');
CkJsonObject_UpdateString(queryParams,'from_date','{{from_date}}');
CkJsonObject_UpdateString(queryParams,'include_recipients','{{include_recipients}}');
CkJsonObject_UpdateString(queryParams,'order','{{order}}');
CkJsonObject_UpdateString(queryParams,'order_by','{{order_by}}');
CkJsonObject_UpdateString(queryParams,'start_position','{{start_position}}');
CkJsonObject_UpdateString(queryParams,'to_date','{{to_date}}');

// Adds the "Authorization: Bearer {{accessToken}}" header.
CkHttp_putAuthToken(http,'{{accessToken}}');
CkHttp_SetRequestHeader(http,'Accept','application/json');

resp := CkHttp_QuickRequestParams(http,'GET','https://domain.com/v2.1/accounts/{{accountId}}/search_folders/{{searchFolderId}}',queryParams);
if (CkHttp_getLastMethodSuccess(http) = False) then
  begin
    Memo1.Lines.Add(CkHttp__lastErrorText(http));
    Exit;
  end;

Memo1.Lines.Add(IntToStr(CkHttpResponse_getStatusCode(resp)));
Memo1.Lines.Add(CkHttpResponse__bodyStr(resp));
CkHttpResponse_Dispose(resp);

CkHttp_Dispose(http);
CkJsonObject_Dispose(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}}"
        },
        {
          "key": "searchFolderId",
          "value": "{{searchFolderId}}"
        }
      ]
    },
    "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": [
  ]
}