(Node.js) DocuSign List Folder Items

See more DocuSign Examples

Retrieves a list of the envelopes in the specified folder.

For more information, see https://developers.docusign.com/docs/esign-rest-api/reference/folders/folders/listitems/

Install Chilkat for Node.js and Electron using npm at Chilkat npm packages for Node.js Chilkat npm packages for Electron on Windows, Linux, MacOSX, and ARM

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}

function chilkatExample() {

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

    var http = new chilkat.Http();
    var success;

    // Implements the following HTTP request:
    // GET /restapi/v2.1/accounts/{accountId}/folders/{folderId}

    // Adds the "Authorization: Bearer eyJ0eXAi.....UE8Kl_V8KroQ" header.
    var jsonToken = new chilkat.JsonObject();
    // Load a previously obtained OAuth2 access token.
    success = jsonToken.LoadFile("qa_data/tokens/docusign.json");
    if (success == false) {
        console.log(jsonToken.LastErrorText);
        return;
    }

    http.AuthToken = jsonToken.StringOf("access_token");

    // Use your account ID and a valid folderId here:
    http.SetUrlVar("accountId","7f3f65ed-5e87-418d-94c1-92499ddc8252");
    http.SetUrlVar("folderId","94644782-31b7-4f82-a2c1-26d8a9306f8c");

    var sbResponseBody = new chilkat.StringBuilder();
    success = http.QuickGetSb("https://demo.docusign.net/restapi/v2.1/accounts/{$accountId}/folders/{$folderId}",sbResponseBody);
    if (success == false) {
        console.log(http.LastErrorText);
        return;
    }

    var jResp = new chilkat.JsonObject();
    jResp.LoadSb(sbResponseBody);
    jResp.EmitCompact = false;

    console.log("Response Body:");
    console.log(jResp.Emit());

    var respStatusCode = http.LastStatus;
    console.log("Response Status Code = " + respStatusCode);
    if (respStatusCode >= 400) {
        console.log("Response Header:");
        console.log(http.LastResponseHeader);
        console.log("Failed.");
        return;
    }

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

    // {
    //   "resultSetSize": "sample string 1",
    //   "startPosition": "sample string 2",
    //   "endPosition": "sample string 3",
    //   "totalSetSize": "sample string 4",
    //   "previousUri": "sample string 5",
    //   "nextUri": "sample string 6",
    //   "folderItems": [
    //     {
    //       "ownerName": "sample string 1",
    //       "envelopeId": "sample string 2",
    //       "envelopeUri": "sample string 3",
    //       "status": "sample string 4",
    //       "senderName": "sample string 5",
    //       "senderEmail": "sample string 6",
    //       "createdDateTime": "sample string 7",
    //       "sentDateTime": "sample string 8",
    //       "completedDateTime": "sample string 9",
    //       "subject": "sample string 10",
    //       "templateId": "sample string 11",
    //       "name": "sample string 12",
    //       "shared": "sample string 13",
    //       "password": "sample string 14",
    //       "description": "sample string 15",
    //       "lastModified": "sample string 16",
    //       "pageCount": 17,
    //       "uri": "sample string 18",
    //       "is21CFRPart11": "sample string 19",
    //       "isSignatureProviderEnvelope": "sample string 20",
    //       "customFields": [
    //         {
    //           "fieldId": "sample string 1",
    //           "name": "sample string 2",
    //           "show": "sample string 3",
    //           "required": "sample string 4",
    //           "value": "sample string 5",
    //           "configurationType": "sample string 6",
    //           "errorDetails": {
    //             "errorCode": "sample string 1",
    //             "message": "sample string 2"
    //           }
    //         }
    //       ]
    //     }
    //   ]
    // }

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

    var ownerName;
    var envelopeId;
    var envelopeUri;
    var status;
    var senderName;
    var senderEmail;
    var createdDateTime;
    var sentDateTime;
    var completedDateTime;
    var subject;
    var templateId;
    var name;
    var shared;
    var password;
    var description;
    var lastModified;
    var pageCount;
    var uri;
    var is21CFRPart11;
    var isSignatureProviderEnvelope;
    var j;
    var count_j;
    var fieldId;
    var show;
    var required;
    var value;
    var configurationType;
    var errorDetailsErrorCode;
    var errorDetailsMessage;

    var resultSetSize = jResp.StringOf("resultSetSize");
    var startPosition = jResp.StringOf("startPosition");
    var endPosition = jResp.StringOf("endPosition");
    var totalSetSize = jResp.StringOf("totalSetSize");
    var previousUri = jResp.StringOf("previousUri");
    var nextUri = jResp.StringOf("nextUri");
    var i = 0;
    var count_i = jResp.SizeOfArray("folderItems");
    while (i < count_i) {
        jResp.I = i;
        ownerName = jResp.StringOf("folderItems[i].ownerName");
        envelopeId = jResp.StringOf("folderItems[i].envelopeId");
        envelopeUri = jResp.StringOf("folderItems[i].envelopeUri");
        status = jResp.StringOf("folderItems[i].status");
        senderName = jResp.StringOf("folderItems[i].senderName");
        senderEmail = jResp.StringOf("folderItems[i].senderEmail");
        createdDateTime = jResp.StringOf("folderItems[i].createdDateTime");
        sentDateTime = jResp.StringOf("folderItems[i].sentDateTime");
        completedDateTime = jResp.StringOf("folderItems[i].completedDateTime");
        subject = jResp.StringOf("folderItems[i].subject");
        templateId = jResp.StringOf("folderItems[i].templateId");
        name = jResp.StringOf("folderItems[i].name");
        shared = jResp.StringOf("folderItems[i].shared");
        password = jResp.StringOf("folderItems[i].password");
        description = jResp.StringOf("folderItems[i].description");
        lastModified = jResp.StringOf("folderItems[i].lastModified");
        pageCount = jResp.IntOf("folderItems[i].pageCount");
        uri = jResp.StringOf("folderItems[i].uri");
        is21CFRPart11 = jResp.StringOf("folderItems[i].is21CFRPart11");
        isSignatureProviderEnvelope = jResp.StringOf("folderItems[i].isSignatureProviderEnvelope");
        j = 0;
        count_j = jResp.SizeOfArray("folderItems[i].customFields");
        while (j < count_j) {
            jResp.J = j;
            fieldId = jResp.StringOf("folderItems[i].customFields[j].fieldId");
            name = jResp.StringOf("folderItems[i].customFields[j].name");
            show = jResp.StringOf("folderItems[i].customFields[j].show");
            required = jResp.StringOf("folderItems[i].customFields[j].required");
            value = jResp.StringOf("folderItems[i].customFields[j].value");
            configurationType = jResp.StringOf("folderItems[i].customFields[j].configurationType");
            errorDetailsErrorCode = jResp.StringOf("folderItems[i].customFields[j].errorDetails.errorCode");
            errorDetailsMessage = jResp.StringOf("folderItems[i].customFields[j].errorDetails.message");
            j = j+1;
        }

        i = i+1;
    }


}

chilkatExample();