Back to Collection Items
use chilkat();
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
$http = chilkat::CkHttp->new();
# Adds the "Authorization: Bearer <access_token>" header.
$http->put_AuthToken("<access_token>");
$http->SetRequestHeader("Content-Type","application/json");
$sbResponseBody = chilkat::CkStringBuilder->new();
$success = $http->QuickGetSb("https://api.freshbooks.com/comments/business/{{businessId}}/time_entries/search",$sbResponseBody);
if ($success == 0) {
print $http->lastErrorText() . "\r\n";
exit;
}
$jResp = chilkat::CkJsonObject->new();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(0);
print "Response Body:" . "\r\n";
print $jResp->emit() . "\r\n";
$respStatusCode = $http->get_LastStatus();
print "Response Status Code = " . $respStatusCode . "\r\n";
if ($respStatusCode >= 400) {
print "Response Header:" . "\r\n";
print $http->lastHeader() . "\r\n";
print "Failed." . "\r\n";
exit;
}
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "time_entries": [
# {
# "id": 47654134,
# "identity_id": 37256,
# "timer": null,
# "is_logged": true,
# "started_at": "2016-08-16T20:00:00Z",
# "created_at": "2019-04-18T20:50:28Z",
# "duration": 7200,
# "client_id": 31006,
# "project_id": 2976412,
# "pending_client": null,
# "pending_project": null,
# "pending_task": null,
# "task_id": null,
# "service_id": null,
# "note": "Stuff",
# "active": true,
# "billable": false,
# "billed": false,
# "internal": false,
# "retainer_id": null,
# "highlight": null
# },
# {
# "id": 47634496,
# "identity_id": 1882548,
# "timer": null,
# "is_logged": true,
# "started_at": "2016-08-16T20:00:00Z",
# "created_at": "2019-04-18T15:16:32Z",
# "duration": 7200,
# "client_id": 31006,
# "project_id": 2976412,
# "pending_client": null,
# "pending_project": null,
# "pending_task": null,
# "task_id": null,
# "service_id": null,
# "note": "Stuff",
# "active": true,
# "billable": false,
# "billed": false,
# "internal": false,
# "retainer_id": null,
# "highlight": null
# },
# {
# "id": 47630482,
# "identity_id": 1882548,
# "timer": null,
# "is_logged": true,
# "started_at": "2019-04-19T04:00:00Z",
# "created_at": "2019-04-18T14:11:34Z",
# "duration": 10800,
# "client_id": 31006,
# "project_id": 2976412,
# "pending_client": null,
# "pending_project": null,
# "pending_task": null,
# "task_id": null,
# "service_id": 3575792,
# "note": null,
# "active": true,
# "billable": false,
# "billed": false,
# "internal": false,
# "retainer_id": null,
# "highlight": null
# },
# {
# "id": 47630476,
# "identity_id": 1882548,
# "timer": null,
# "is_logged": true,
# "started_at": "2019-04-15T04:00:00Z",
# "created_at": "2019-04-18T14:11:34Z",
# "duration": 7200,
# "client_id": 31006,
# "project_id": 2976412,
# "pending_client": null,
# "pending_project": null,
# "pending_task": null,
# "task_id": null,
# "service_id": 3575792,
# "note": null,
# "active": true,
# "billable": false,
# "billed": false,
# "internal": false,
# "retainer_id": null,
# "highlight": null
# },
# {
# "id": 47654186,
# "identity_id": 37256,
# "timer": null,
# "is_logged": true,
# "started_at": "2019-04-18T20:00:00Z",
# "created_at": "2019-04-18T20:51:22Z",
# "duration": 7200,
# "client_id": 31006,
# "project_id": 2976412,
# "pending_client": null,
# "pending_project": null,
# "pending_task": null,
# "task_id": null,
# "service_id": null,
# "note": "Stuff",
# "active": true,
# "billable": false,
# "billed": false,
# "internal": false,
# "retainer_id": null,
# "highlight": null
# },
# {
# "id": 47630480,
# "identity_id": 1882548,
# "timer": null,
# "is_logged": true,
# "started_at": "2019-04-18T04:00:00Z",
# "created_at": "2019-04-18T14:11:34Z",
# "duration": 7200,
# "client_id": 31006,
# "project_id": 2976412,
# "pending_client": null,
# "pending_project": null,
# "pending_task": null,
# "task_id": null,
# "service_id": 3575792,
# "note": null,
# "active": true,
# "billable": false,
# "billed": false,
# "internal": false,
# "retainer_id": null,
# "highlight": null
# },
# {
# "id": 47630478,
# "identity_id": 1882548,
# "timer": null,
# "is_logged": true,
# "started_at": "2019-04-17T04:00:00Z",
# "created_at": "2019-04-18T14:11:34Z",
# "duration": 7200,
# "client_id": 31006,
# "project_id": 2976412,
# "pending_client": null,
# "pending_project": null,
# "pending_task": null,
# "task_id": null,
# "service_id": 3575792,
# "note": null,
# "active": true,
# "billable": false,
# "billed": false,
# "internal": false,
# "retainer_id": null,
# "highlight": null
# },
# {
# "id": 47632920,
# "identity_id": 1882548,
# "timer": null,
# "is_logged": true,
# "started_at": "2016-08-16T20:00:00Z",
# "created_at": "2019-04-18T14:58:17Z",
# "duration": 7200,
# "client_id": 31006,
# "project_id": 2976412,
# "pending_client": null,
# "pending_project": null,
# "pending_task": null,
# "task_id": null,
# "service_id": null,
# "note": "Stuff",
# "active": true,
# "billable": false,
# "billed": false,
# "internal": false,
# "retainer_id": null,
# "highlight": null
# },
# {
# "id": 47632874,
# "identity_id": 1882548,
# "timer": null,
# "is_logged": true,
# "started_at": "2016-08-16T20:00:00Z",
# "created_at": "2019-04-18T14:57:34Z",
# "duration": 7200,
# "client_id": 31006,
# "project_id": 2976412,
# "pending_client": null,
# "pending_project": null,
# "pending_task": null,
# "task_id": null,
# "service_id": null,
# "note": "Stuff",
# "active": true,
# "billable": false,
# "billed": false,
# "internal": false,
# "retainer_id": null,
# "highlight": null
# }
# ],
# "meta": {
# "total": 9,
# "per_page": 30,
# "page": 1,
# "pages": 1,
# "total_logged": 0,
# "total_unbilled": 0
# },
# "aggregations": null,
# "download_token": null,
# "abilities": [
# {
# "time_entry_id": 47654134,
# "abilities": [
# {
# "name": "can_edit",
# "value": true
# },
# {
# "name": "can_delete",
# "value": true
# }
# ]
# },
# {
# "time_entry_id": 47634496,
# "abilities": [
# {
# "name": "can_edit",
# "value": true
# },
# {
# "name": "can_delete",
# "value": true
# }
# ]
# },
# {
# "time_entry_id": 47630482,
# "abilities": [
# {
# "name": "can_edit",
# "value": true
# },
# {
# "name": "can_delete",
# "value": true
# }
# ]
# },
# {
# "time_entry_id": 47630476,
# "abilities": [
# {
# "name": "can_edit",
# "value": true
# },
# {
# "name": "can_delete",
# "value": true
# }
# ]
# },
# {
# "time_entry_id": 47654186,
# "abilities": [
# {
# "name": "can_edit",
# "value": true
# },
# {
# "name": "can_delete",
# "value": true
# }
# ]
# },
# {
# "time_entry_id": 47630480,
# "abilities": [
# {
# "name": "can_edit",
# "value": true
# },
# {
# "name": "can_delete",
# "value": true
# }
# ]
# },
# {
# "time_entry_id": 47630478,
# "abilities": [
# {
# "name": "can_edit",
# "value": true
# },
# {
# "name": "can_delete",
# "value": true
# }
# ]
# },
# {
# "time_entry_id": 47632920,
# "abilities": [
# {
# "name": "can_edit",
# "value": true
# },
# {
# "name": "can_delete",
# "value": true
# }
# ]
# },
# {
# "time_entry_id": 47632874,
# "abilities": [
# {
# "name": "can_edit",
# "value": true
# },
# {
# "name": "can_delete",
# "value": true
# }
# ]
# }
# ]
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
$Total = $jResp->IntOf("meta.total");
$Per_page = $jResp->IntOf("meta.per_page");
$Page = $jResp->IntOf("meta.page");
$Pages = $jResp->IntOf("meta.pages");
$Total_logged = $jResp->IntOf("meta.total_logged");
$Total_unbilled = $jResp->IntOf("meta.total_unbilled");
$aggregations = $jResp->stringOf("aggregations");
$download_token = $jResp->stringOf("download_token");
$i = 0;
$count_i = $jResp->SizeOfArray("time_entries");
while ($i < $count_i) {
$jResp->put_I($i);
$id = $jResp->IntOf("time_entries[i].id");
$identity_id = $jResp->IntOf("time_entries[i].identity_id");
$timer = $jResp->stringOf("time_entries[i].timer");
$is_logged = $jResp->BoolOf("time_entries[i].is_logged");
$started_at = $jResp->stringOf("time_entries[i].started_at");
$created_at = $jResp->stringOf("time_entries[i].created_at");
$duration = $jResp->IntOf("time_entries[i].duration");
$client_id = $jResp->IntOf("time_entries[i].client_id");
$project_id = $jResp->IntOf("time_entries[i].project_id");
$pending_client = $jResp->stringOf("time_entries[i].pending_client");
$pending_project = $jResp->stringOf("time_entries[i].pending_project");
$pending_task = $jResp->stringOf("time_entries[i].pending_task");
$task_id = $jResp->stringOf("time_entries[i].task_id");
$service_id = $jResp->stringOf("time_entries[i].service_id");
$note = $jResp->stringOf("time_entries[i].note");
$active = $jResp->BoolOf("time_entries[i].active");
$billable = $jResp->BoolOf("time_entries[i].billable");
$billed = $jResp->BoolOf("time_entries[i].billed");
$internal = $jResp->BoolOf("time_entries[i].internal");
$retainer_id = $jResp->stringOf("time_entries[i].retainer_id");
$highlight = $jResp->stringOf("time_entries[i].highlight");
$i = $i + 1;
}
$i = 0;
$count_i = $jResp->SizeOfArray("abilities");
while ($i < $count_i) {
$jResp->put_I($i);
$time_entry_id = $jResp->IntOf("abilities[i].time_entry_id");
$j = 0;
$count_j = $jResp->SizeOfArray("abilities[i].abilities");
while ($j < $count_j) {
$jResp->put_J($j);
$name = $jResp->stringOf("abilities[i].abilities[j].name");
$value = $jResp->BoolOf("abilities[i].abilities[j].value");
$j = $j + 1;
}
$i = $i + 1;
}
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
https://api.freshbooks.com/comments/business/{{businessId}}/time_entries/search
Postman Collection Item JSON
{
"name": "Time Entry Details",
"request": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text",
"disabled": true
}
],
"url": {
"raw": "https://api.freshbooks.com/comments/business/{{businessId}}/time_entries/search",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"comments",
"business",
"{{businessId}}",
"time_entries",
"search"
],
"query": [
{
"key": "group_by",
"value": "clients",
"description": "Group by clients, vendor, ",
"disabled": true
},
{
"key": "include_jwt",
"value": "true",
"description": "Boolean, includes JWT token if true. ",
"disabled": true
},
{
"key": "timezone",
"value": "America%2FToronto",
"disabled": true
},
{
"key": "billable",
"value": "1",
"disabled": true
},
{
"key": "billed",
"value": "1",
"disabled": true
},
{
"key": "project_id",
"value": "2980874",
"description": "Filter by Project using `project_id`",
"disabled": true
},
{
"key": "identity_id",
"value": "37256",
"description": "Filter by Staff using `identity_id`",
"disabled": true
},
{
"key": "date_gte",
"value": "2019-03-01T05%3A00%3A00Z",
"disabled": true
},
{
"key": "date_lte",
"value": "2019-04-01T03%3A59%3A59Z",
"disabled": true
},
{
"key": "sort",
"value": "-started_at",
"disabled": true
}
]
},
"description": "A detailed summary of how much time you and/or your team tracked over a period of time. \n\n*Reminder to not use `Content-Type` when calling for time-entry details*"
},
"response": [
{
"name": "Time Entry Details",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"type": "text",
"disabled": true
}
],
"url": {
"raw": "https://api.freshbooks.com/comments/business/{{businessId}}/time_entries/search",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"comments",
"business",
"{{businessId}}",
"time_entries",
"search"
],
"query": [
{
"key": "group_by",
"value": "clients",
"description": "Group by clients, vendor, ",
"disabled": true
},
{
"key": "include_jwt",
"value": "true",
"description": "Boolean, includes JWT token if true. ",
"disabled": true
},
{
"key": "timezone",
"value": "America%2FToronto",
"disabled": true
},
{
"key": "billable",
"value": "1",
"disabled": true
},
{
"key": "billed",
"value": "1",
"disabled": true
},
{
"key": "project_id",
"value": "2980874",
"description": "Filter by Project using `project_id`",
"disabled": true
},
{
"key": "identity_id",
"value": "37256",
"description": "Filter by Staff using `identity_id`",
"disabled": true
},
{
"key": "date_gte",
"value": "2019-03-01T05%3A00%3A00Z",
"disabled": true
},
{
"key": "date_lte",
"value": "2019-04-01T03%3A59%3A59Z",
"disabled": true
},
{
"key": "sort",
"value": "-started_at",
"disabled": true
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/vnd.api+json"
},
{
"key": "X-Version",
"value": "1904.25.0"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVllUBAQOU10TGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4FDFZFVRYSBxlDUhULRERQBxVNFlkPXT1dVkBAWgBKPkIEUhAHXhkTAxBXRkIHBFhDWFoDO1RYRxAPBhFvEV0DSltcEB9VFVEfUANRUQcOVVVaDgoHVldXAQMbS1UdFFZUUlUHVlJaUQsJBFZWV11DHQdSDhdTag=="
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Tue, 24 Apr 2018 18:32:22 GMT"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Via",
"value": "1.1 google"
},
{
"key": "Via",
"value": "1.1 varnish"
},
{
"key": "Accept-Ranges",
"value": "bytes"
},
{
"key": "Accept-Ranges",
"value": "bytes"
},
{
"key": "Age",
"value": "0"
},
{
"key": "Age",
"value": "0"
},
{
"key": "Content-Length",
"value": "5298"
},
{
"key": "Date",
"value": "Wed, 24 Apr 2019 18:32:22 GMT"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "X-Served-By",
"value": "cache-mdw17369-MDW"
},
{
"key": "X-Cache",
"value": "MISS"
},
{
"key": "X-Cache-Hits",
"value": "0"
},
{
"key": "Country",
"value": "CA"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=31536000; includeSubDomains; preload"
}
],
"cookie": [
],
"body": "{\n \"time_entries\": [\n {\n \"id\": 47654134,\n \"identity_id\": 37256,\n \"timer\": null,\n \"is_logged\": true,\n \"started_at\": \"2016-08-16T20:00:00Z\",\n \"created_at\": \"2019-04-18T20:50:28Z\",\n \"duration\": 7200,\n \"client_id\": 31006,\n \"project_id\": 2976412,\n \"pending_client\": null,\n \"pending_project\": null,\n \"pending_task\": null,\n \"task_id\": null,\n \"service_id\": null,\n \"note\": \"Stuff\",\n \"active\": true,\n \"billable\": false,\n \"billed\": false,\n \"internal\": false,\n \"retainer_id\": null,\n \"highlight\": null\n },\n {\n \"id\": 47634496,\n \"identity_id\": 1882548,\n \"timer\": null,\n \"is_logged\": true,\n \"started_at\": \"2016-08-16T20:00:00Z\",\n \"created_at\": \"2019-04-18T15:16:32Z\",\n \"duration\": 7200,\n \"client_id\": 31006,\n \"project_id\": 2976412,\n \"pending_client\": null,\n \"pending_project\": null,\n \"pending_task\": null,\n \"task_id\": null,\n \"service_id\": null,\n \"note\": \"Stuff\",\n \"active\": true,\n \"billable\": false,\n \"billed\": false,\n \"internal\": false,\n \"retainer_id\": null,\n \"highlight\": null\n },\n {\n \"id\": 47630482,\n \"identity_id\": 1882548,\n \"timer\": null,\n \"is_logged\": true,\n \"started_at\": \"2019-04-19T04:00:00Z\",\n \"created_at\": \"2019-04-18T14:11:34Z\",\n \"duration\": 10800,\n \"client_id\": 31006,\n \"project_id\": 2976412,\n \"pending_client\": null,\n \"pending_project\": null,\n \"pending_task\": null,\n \"task_id\": null,\n \"service_id\": 3575792,\n \"note\": null,\n \"active\": true,\n \"billable\": false,\n \"billed\": false,\n \"internal\": false,\n \"retainer_id\": null,\n \"highlight\": null\n },\n {\n \"id\": 47630476,\n \"identity_id\": 1882548,\n \"timer\": null,\n \"is_logged\": true,\n \"started_at\": \"2019-04-15T04:00:00Z\",\n \"created_at\": \"2019-04-18T14:11:34Z\",\n \"duration\": 7200,\n \"client_id\": 31006,\n \"project_id\": 2976412,\n \"pending_client\": null,\n \"pending_project\": null,\n \"pending_task\": null,\n \"task_id\": null,\n \"service_id\": 3575792,\n \"note\": null,\n \"active\": true,\n \"billable\": false,\n \"billed\": false,\n \"internal\": false,\n \"retainer_id\": null,\n \"highlight\": null\n },\n {\n \"id\": 47654186,\n \"identity_id\": 37256,\n \"timer\": null,\n \"is_logged\": true,\n \"started_at\": \"2019-04-18T20:00:00Z\",\n \"created_at\": \"2019-04-18T20:51:22Z\",\n \"duration\": 7200,\n \"client_id\": 31006,\n \"project_id\": 2976412,\n \"pending_client\": null,\n \"pending_project\": null,\n \"pending_task\": null,\n \"task_id\": null,\n \"service_id\": null,\n \"note\": \"Stuff\",\n \"active\": true,\n \"billable\": false,\n \"billed\": false,\n \"internal\": false,\n \"retainer_id\": null,\n \"highlight\": null\n },\n {\n \"id\": 47630480,\n \"identity_id\": 1882548,\n \"timer\": null,\n \"is_logged\": true,\n \"started_at\": \"2019-04-18T04:00:00Z\",\n \"created_at\": \"2019-04-18T14:11:34Z\",\n \"duration\": 7200,\n \"client_id\": 31006,\n \"project_id\": 2976412,\n \"pending_client\": null,\n \"pending_project\": null,\n \"pending_task\": null,\n \"task_id\": null,\n \"service_id\": 3575792,\n \"note\": null,\n \"active\": true,\n \"billable\": false,\n \"billed\": false,\n \"internal\": false,\n \"retainer_id\": null,\n \"highlight\": null\n },\n {\n \"id\": 47630478,\n \"identity_id\": 1882548,\n \"timer\": null,\n \"is_logged\": true,\n \"started_at\": \"2019-04-17T04:00:00Z\",\n \"created_at\": \"2019-04-18T14:11:34Z\",\n \"duration\": 7200,\n \"client_id\": 31006,\n \"project_id\": 2976412,\n \"pending_client\": null,\n \"pending_project\": null,\n \"pending_task\": null,\n \"task_id\": null,\n \"service_id\": 3575792,\n \"note\": null,\n \"active\": true,\n \"billable\": false,\n \"billed\": false,\n \"internal\": false,\n \"retainer_id\": null,\n \"highlight\": null\n },\n {\n \"id\": 47632920,\n \"identity_id\": 1882548,\n \"timer\": null,\n \"is_logged\": true,\n \"started_at\": \"2016-08-16T20:00:00Z\",\n \"created_at\": \"2019-04-18T14:58:17Z\",\n \"duration\": 7200,\n \"client_id\": 31006,\n \"project_id\": 2976412,\n \"pending_client\": null,\n \"pending_project\": null,\n \"pending_task\": null,\n \"task_id\": null,\n \"service_id\": null,\n \"note\": \"Stuff\",\n \"active\": true,\n \"billable\": false,\n \"billed\": false,\n \"internal\": false,\n \"retainer_id\": null,\n \"highlight\": null\n },\n {\n \"id\": 47632874,\n \"identity_id\": 1882548,\n \"timer\": null,\n \"is_logged\": true,\n \"started_at\": \"2016-08-16T20:00:00Z\",\n \"created_at\": \"2019-04-18T14:57:34Z\",\n \"duration\": 7200,\n \"client_id\": 31006,\n \"project_id\": 2976412,\n \"pending_client\": null,\n \"pending_project\": null,\n \"pending_task\": null,\n \"task_id\": null,\n \"service_id\": null,\n \"note\": \"Stuff\",\n \"active\": true,\n \"billable\": false,\n \"billed\": false,\n \"internal\": false,\n \"retainer_id\": null,\n \"highlight\": null\n }\n ],\n \"meta\": {\n \"total\": 9,\n \"per_page\": 30,\n \"page\": 1,\n \"pages\": 1,\n \"total_logged\": 0,\n \"total_unbilled\": 0\n },\n \"aggregations\": null,\n \"download_token\": null,\n \"abilities\": [\n {\n \"time_entry_id\": 47654134,\n \"abilities\": [\n {\n \"name\": \"can_edit\",\n \"value\": true\n },\n {\n \"name\": \"can_delete\",\n \"value\": true\n }\n ]\n },\n {\n \"time_entry_id\": 47634496,\n \"abilities\": [\n {\n \"name\": \"can_edit\",\n \"value\": true\n },\n {\n \"name\": \"can_delete\",\n \"value\": true\n }\n ]\n },\n {\n \"time_entry_id\": 47630482,\n \"abilities\": [\n {\n \"name\": \"can_edit\",\n \"value\": true\n },\n {\n \"name\": \"can_delete\",\n \"value\": true\n }\n ]\n },\n {\n \"time_entry_id\": 47630476,\n \"abilities\": [\n {\n \"name\": \"can_edit\",\n \"value\": true\n },\n {\n \"name\": \"can_delete\",\n \"value\": true\n }\n ]\n },\n {\n \"time_entry_id\": 47654186,\n \"abilities\": [\n {\n \"name\": \"can_edit\",\n \"value\": true\n },\n {\n \"name\": \"can_delete\",\n \"value\": true\n }\n ]\n },\n {\n \"time_entry_id\": 47630480,\n \"abilities\": [\n {\n \"name\": \"can_edit\",\n \"value\": true\n },\n {\n \"name\": \"can_delete\",\n \"value\": true\n }\n ]\n },\n {\n \"time_entry_id\": 47630478,\n \"abilities\": [\n {\n \"name\": \"can_edit\",\n \"value\": true\n },\n {\n \"name\": \"can_delete\",\n \"value\": true\n }\n ]\n },\n {\n \"time_entry_id\": 47632920,\n \"abilities\": [\n {\n \"name\": \"can_edit\",\n \"value\": true\n },\n {\n \"name\": \"can_delete\",\n \"value\": true\n }\n ]\n },\n {\n \"time_entry_id\": 47632874,\n \"abilities\": [\n {\n \"name\": \"can_edit\",\n \"value\": true\n },\n {\n \"name\": \"can_delete\",\n \"value\": true\n }\n ]\n }\n ]\n}"
}
]
}
