Node.js Box: Get Folder Items

Back to Index

Gets all of the files, folders, or web links contained within a folder.

Documentation: https://developer.box.com/reference#get-a-folders-items

CURL Command

curl https://api.box.com/2.0/folders/BOX_FOLDER_ID/items?limit=2&offset=0 \
-H "Authorization: Bearer BOX_ACCESS_TOKEN"

Node.js Example

var os = require('os');
if (os.platform() == 'win32') {  
    var chilkat = require('chilkat_node6_win32'); 
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('chilkat_node6_arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('chilkat_node6_linux32');
    } else {
        var chilkat = require('chilkat_node6_linux64');
    }
} else if (os.platform() == 'darwin') {
    var chilkat = require('chilkat_node6_macosx');
}

function chilkatExample() {

    var rest = new chilkat.Rest();
    var success;

    //  URL: https://api.box.com/2.0/folders/BOX_FOLDER_ID/items?limit=2&offset=0
    var bTls = true;
    var port = 443;
    var bAutoReconnect = true;
    success = rest.Connect("api.box.com",port,bTls,bAutoReconnect);
    if (success !== true) {
        console.log("ConnectFailReason: " + rest.ConnectFailReason);
        console.log(rest.LastErrorText);
        return;
    }

    rest.AddHeader("Authorization","Bearer BOX_ACCESS_TOKEN");

    var sbResponseBody = new chilkat.StringBuilder();
    success = rest.FullRequestNoBodySb("GET","/2.0/folders/BOX_FOLDER_ID/items?limit=2&offset=0",sbResponseBody);
    if (success !== true) {
        console.log(rest.LastErrorText);
        return;
    }

    var jsonResponse = new chilkat.JsonObject();
    jsonResponse.LoadSb(sbResponseBody);

    var total_count;
    var offset;
    var limit;
    var i;
    var count_i;
    var type;
    var id;
    var file_versionType;
    var file_versionId;
    var file_versionSha1;
    var sequence_id;
    var etag;
    var sha1;
    var name;
    var by;
    var direction;

    total_count = jsonResponse.IntOf("total_count");
    offset = jsonResponse.IntOf("offset");
    limit = jsonResponse.IntOf("limit");
    i = 0;
    count_i = jsonResponse.SizeOfArray("entries");
    while (i < count_i) {
        jsonResponse.I = i;
        type = jsonResponse.StringOf("entries[i].type");
        id = jsonResponse.StringOf("entries[i].id");
        file_versionType = jsonResponse.StringOf("entries[i].file_version.type");
        file_versionId = jsonResponse.StringOf("entries[i].file_version.id");
        file_versionSha1 = jsonResponse.StringOf("entries[i].file_version.sha1");
        sequence_id = jsonResponse.StringOf("entries[i].sequence_id");
        etag = jsonResponse.StringOf("entries[i].etag");
        sha1 = jsonResponse.StringOf("entries[i].sha1");
        name = jsonResponse.StringOf("entries[i].name");
        i = i+1;
    }

    i = 0;
    count_i = jsonResponse.SizeOfArray("order");
    while (i < count_i) {
        jsonResponse.I = i;
        by = jsonResponse.StringOf("order[i].by");
        direction = jsonResponse.StringOf("order[i].direction");
        i = i+1;
    }


}

chilkatExample();

Sample JSON Response Body

{
  "total_count": 2,
  "entries": [
    {
      "type": "file",
      "id": "246181882790",
      "file_version": {
        "type": "file_version",
        "id": "259636211878",
        "sha1": "c9d2492fb97f88a9b4d1e35f32a3410e95853f18"
      },
      "sequence_id": "0",
      "etag": "0",
      "sha1": "c9d2492fb97f88a9b4d1e35f32a3410e95853f18",
      "name": "hedgehogs.jpg"
    },
    {
      "type": "file",
      "id": "246167973161",
      "file_version": {
        "type": "file_version",
        "id": "259621592361",
        "sha1": "df7be9dc4f467187783aca68c7ce98e4df2172d0"
      },
      "sequence_id": "0",
      "etag": "0",
      "sha1": "df7be9dc4f467187783aca68c7ce98e4df2172d0",
      "name": "penguins.jpg"
    }
  ],
  "offset": 0,
  "limit": 2,
  "order": [
    {
      "by": "type",
      "direction": "ASC"
    },
    {
      "by": "name",
      "direction": "ASC"
    }
  ]
}