(JavaScript) GetHarvest - List Clients

Returns a list of your clients.

For more information, see https://help.getharvest.com/api-v2/clients-api/clients/clients/

Note

This example is intended for running within a Chilkat.Js embedded JavaScript engine. All Chilkat JavaScript examples require Chilkat v11.4.0 or greater.

var success = false;

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

var http = new CkHttp();

// Implements the following CURL command:

// curl "https://api.harvestapp.com/v2/clients" \
//   -H "Authorization: Bearer ACCESS_TOKEN" \
//   -H "Harvest-Account-Id: ACCOUNT_ID" \
//   -H "User-Agent: MyApp (yourname@example.com)"

http.SetRequestHeader("User-Agent","MyApp (yourname@example.com)");
http.SetRequestHeader("Authorization","Bearer ACCESS_TOKEN");
http.SetRequestHeader("Harvest-Account-Id","ACCOUNT_ID");

var sbResponseBody = new CkStringBuilder();
success = http.QuickGetSb("https://api.harvestapp.com/v2/clients",sbResponseBody);
if (success == false) {
    console.log(http.LastErrorText);
    return;
}

var jResp = new CkJsonObject();
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.LastHeader);
    console.log("Failed.");
    return;
}

// Sample JSON response:

// {
//   "clients": [
//     {
//       "id": 5735776,
//       "name": "123 Industries",
//       "is_active": true,
//       "address": "123 Main St.\r\nAnytown, LA 71223",
//       "created_at": "2017-06-26T21:02:12Z",
//       "updated_at": "2017-06-26T21:34:11Z",
//       "currency": "EUR"
//     },
//     {
//       "id": 5735774,
//       "name": "ABC Corp",
//       "is_active": true,
//       "address": "456 Main St.\r\nAnytown, CT 06467",
//       "created_at": "2017-06-26T21:01:52Z",
//       "updated_at": "2017-06-26T21:27:07Z",
//       "currency": "USD"
//     }
//   ],
//   "per_page": 100,
//   "total_pages": 1,
//   "total_entries": 2,
//   "next_page": null,
//   "previous_page": null,
//   "page": 1,
//   "links": {
//     "first": "https://api.harvestapp.com/v2/clients?page=1&per_page=100",
//     "next": null,
//     "previous": null,
//     "last": "https://api.harvestapp.com/v2/clients?page=1&per_page=100"
//   }
// }

// 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 per_page;
var total_pages;
var total_entries;
var next_page;
var previous_page;
var page;
var linksFirst;
var linksNext;
var linksPrevious;
var linksLast;
var i;
var count_i;
var id;
var name;
var is_active;
var address;
var created_at;
var updated_at;
var currency;

per_page = jResp.IntOf("per_page");
total_pages = jResp.IntOf("total_pages");
total_entries = jResp.IntOf("total_entries");
next_page = jResp.StringOf("next_page");
previous_page = jResp.StringOf("previous_page");
page = jResp.IntOf("page");
linksFirst = jResp.StringOf("links.first");
linksNext = jResp.StringOf("links.next");
linksPrevious = jResp.StringOf("links.previous");
linksLast = jResp.StringOf("links.last");
i = 0;
count_i = jResp.SizeOfArray("clients");
while (i < count_i) {
    jResp.I = i;
    id = jResp.IntOf("clients[i].id");
    name = jResp.StringOf("clients[i].name");
    is_active = jResp.BoolOf("clients[i].is_active");
    address = jResp.StringOf("clients[i].address");
    created_at = jResp.StringOf("clients[i].created_at");
    updated_at = jResp.StringOf("clients[i].updated_at");
    currency = jResp.StringOf("clients[i].currency");
    i = i+1;
}