Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
; Adds the "Authorization: Bearer <access_token>" header.
$oHttp.AuthToken = "<access_token>"
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://api.freshbooks.com/projects/business/{{businessId}}/projects",$oSbResponseBody)
If ($bSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oHttp.LastHeader & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "meta": {
; "sort": [
; ],
; "total": 5,
; "per_page": 30,
; "page": 1,
; "pages": 1
; },
; "projects": [
; {
; "id": 2980878,
; "title": "K2 Hiking Guide",
; "description": null,
; "due_date": "2019-04-20",
; "client_id": 31006,
; "internal": false,
; "budget": null,
; "fixed_price": "2000.00",
; "rate": null,
; "billing_method": null,
; "project_type": "fixed_price",
; "active": true,
; "complete": false,
; "sample": false,
; "created_at": "2019-04-19T18:25:00",
; "updated_at": "2019-04-19T19:50:26",
; "logged_duration": null,
; "services": [
; ],
; "billed_amount": "0.00",
; "billed_status": "unbilled",
; "group_id": 4951020
; },
; {
; "id": 2980874,
; "title": "Applachian Hiking Guide",
; "description": null,
; "due_date": "2019-05-20",
; "client_id": 31006,
; "internal": false,
; "budget": null,
; "fixed_price": "1000.00",
; "rate": null,
; "billing_method": null,
; "project_type": "fixed_price",
; "active": true,
; "complete": false,
; "sample": false,
; "created_at": "2019-04-19T18:22:43",
; "updated_at": "2019-04-19T18:22:43",
; "logged_duration": null,
; "services": [
; ],
; "billed_amount": "0.00",
; "billed_status": "unbilled",
; "group_id": 4951012
; },
; {
; "id": 2980872,
; "title": "Applachian Hiking Guide",
; "description": null,
; "due_date": "2019-05-20",
; "client_id": 31006,
; "internal": false,
; "budget": null,
; "fixed_price": "1000.00",
; "rate": null,
; "billing_method": null,
; "project_type": "fixed_price",
; "active": true,
; "complete": false,
; "sample": false,
; "created_at": "2019-04-19T18:22:06",
; "updated_at": "2019-04-19T18:22:06",
; "logged_duration": null,
; "services": [
; ],
; "billed_amount": "0.00",
; "billed_status": "unbilled",
; "group_id": 4951006
; },
; {
; "id": 2980870,
; "title": "Hiking Guide",
; "description": null,
; "due_date": "2019-05-20",
; "client_id": 31006,
; "internal": false,
; "budget": null,
; "fixed_price": "500.00",
; "rate": null,
; "billing_method": null,
; "project_type": "fixed_price",
; "active": true,
; "complete": false,
; "sample": false,
; "created_at": "2019-04-19T18:21:11",
; "updated_at": "2019-04-19T18:21:11",
; "logged_duration": null,
; "services": [
; ],
; "billed_amount": "0.00",
; "billed_status": "unbilled",
; "group_id": 4951004
; },
; {
; "id": 2976412,
; "title": "Very Custom Computer thing",
; "description": null,
; "due_date": null,
; "client_id": 31006,
; "internal": false,
; "budget": null,
; "fixed_price": null,
; "rate": null,
; "billing_method": "project_rate",
; "project_type": "fixed_price",
; "active": true,
; "complete": false,
; "sample": false,
; "created_at": "2019-04-18T13:43:31",
; "updated_at": "2019-04-18T13:43:31",
; "logged_duration": null,
; "services": [
; {
; "business_id": 1966214,
; "id": 3575792,
; "name": "Computer Hardware",
; "billable": true,
; "vis_state": 0
; }
; ],
; "billed_amount": "0.00",
; "billed_status": "unbilled",
; "group_id": 4942784
; }
; ]
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Local $id
Local $sTitle
Local $sDescription
Local $sDue_date
Local $iClient_id
Local $bInternal
Local $sBudget
Local $sFixed_price
Local $sRate
Local $sBilling_method
Local $sProject_type
Local $bActive
Local $bComplete
Local $bSample
Local $sCreated_at
Local $sUpdated_at
Local $sLogged_duration
Local $sBilled_amount
Local $sBilled_status
Local $iGroup_id
Local $iJ
Local $iCount_j
Local $iBusiness_id
Local $sName
Local $billable
Local $iVis_state
Local $iTotal = $oJResp.IntOf("meta.total")
Local $iPer_page = $oJResp.IntOf("meta.per_page")
Local $iPage = $oJResp.IntOf("meta.page")
Local $iPages = $oJResp.IntOf("meta.pages")
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("meta.sort")
While $i < $iCount_i
$oJResp.I = $i
$i = $i + 1
Wend
$i = 0
$iCount_i = $oJResp.SizeOfArray("projects")
While $i < $iCount_i
$oJResp.I = $i
$id = $oJResp.IntOf("projects[i].id")
$sTitle = $oJResp.StringOf("projects[i].title")
$sDescription = $oJResp.StringOf("projects[i].description")
$sDue_date = $oJResp.StringOf("projects[i].due_date")
$iClient_id = $oJResp.IntOf("projects[i].client_id")
$bInternal = $oJResp.BoolOf("projects[i].internal")
$sBudget = $oJResp.StringOf("projects[i].budget")
$sFixed_price = $oJResp.StringOf("projects[i].fixed_price")
$sRate = $oJResp.StringOf("projects[i].rate")
$sBilling_method = $oJResp.StringOf("projects[i].billing_method")
$sProject_type = $oJResp.StringOf("projects[i].project_type")
$bActive = $oJResp.BoolOf("projects[i].active")
$bComplete = $oJResp.BoolOf("projects[i].complete")
$bSample = $oJResp.BoolOf("projects[i].sample")
$sCreated_at = $oJResp.StringOf("projects[i].created_at")
$sUpdated_at = $oJResp.StringOf("projects[i].updated_at")
$sLogged_duration = $oJResp.StringOf("projects[i].logged_duration")
$sBilled_amount = $oJResp.StringOf("projects[i].billed_amount")
$sBilled_status = $oJResp.StringOf("projects[i].billed_status")
$iGroup_id = $oJResp.IntOf("projects[i].group_id")
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("projects[i].services")
While $iJ < $iCount_j
$oJResp.J = $iJ
$iBusiness_id = $oJResp.IntOf("projects[i].services[j].business_id")
$id = $oJResp.IntOf("projects[i].services[j].id")
$sName = $oJResp.StringOf("projects[i].services[j].name")
$billable = $oJResp.BoolOf("projects[i].services[j].billable")
$iVis_state = $oJResp.IntOf("projects[i].services[j].vis_state")
$iJ = $iJ + 1
Wend
$i = $i + 1
Wend
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
https://api.freshbooks.com/projects/business/{{businessId}}/projects
Postman Collection Item JSON
{
"name": "List Projects",
"event": [
{
"listen": "test",
"script": {
"exec": [
"let jsonData = JSON.parse(responseBody);",
"pm.environment.set(\"projectId\", jsonData.projects[0].id);"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.freshbooks.com/projects/business/{{businessId}}/projects",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"projects",
"business",
"{{businessId}}",
"projects"
]
},
"description": "Remember to remove `Content-Type` headers when making a GET call on projects and time-tracking."
},
"response": [
{
"name": "List Projects",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.freshbooks.com/projects/business/{{businessId}}/projects",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"projects",
"business",
"{{businessId}}",
"projects"
]
}
},
"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.24.0"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVllUBAQOU10TGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4FDFZFVRYSBxlDUhULRERQBxVNEkINUgdbTEccQQBKDkQTUAdeRkUODAZbR0NGTVIbARlWUgYBA1FfVVADUA5SDAEMHh5UFUMAVVdUUA9VWAUCD1IIUlhQFR1RBwhCU24="
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Tue, 24 Apr 2018 18:24:44 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": "2629"
},
{
"key": "Date",
"value": "Wed, 24 Apr 2019 18:24:44 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 \"meta\": {\n \"sort\": [],\n \"total\": 5,\n \"per_page\": 30,\n \"page\": 1,\n \"pages\": 1\n },\n \"projects\": [\n {\n \"id\": 2980878,\n \"title\": \"K2 Hiking Guide\",\n \"description\": null,\n \"due_date\": \"2019-04-20\",\n \"client_id\": 31006,\n \"internal\": false,\n \"budget\": null,\n \"fixed_price\": \"2000.00\",\n \"rate\": null,\n \"billing_method\": null,\n \"project_type\": \"fixed_price\",\n \"active\": true,\n \"complete\": false,\n \"sample\": false,\n \"created_at\": \"2019-04-19T18:25:00\",\n \"updated_at\": \"2019-04-19T19:50:26\",\n \"logged_duration\": null,\n \"services\": [],\n \"billed_amount\": \"0.00\",\n \"billed_status\": \"unbilled\",\n \"group_id\": 4951020\n },\n {\n \"id\": 2980874,\n \"title\": \"Applachian Hiking Guide\",\n \"description\": null,\n \"due_date\": \"2019-05-20\",\n \"client_id\": 31006,\n \"internal\": false,\n \"budget\": null,\n \"fixed_price\": \"1000.00\",\n \"rate\": null,\n \"billing_method\": null,\n \"project_type\": \"fixed_price\",\n \"active\": true,\n \"complete\": false,\n \"sample\": false,\n \"created_at\": \"2019-04-19T18:22:43\",\n \"updated_at\": \"2019-04-19T18:22:43\",\n \"logged_duration\": null,\n \"services\": [],\n \"billed_amount\": \"0.00\",\n \"billed_status\": \"unbilled\",\n \"group_id\": 4951012\n },\n {\n \"id\": 2980872,\n \"title\": \"Applachian Hiking Guide\",\n \"description\": null,\n \"due_date\": \"2019-05-20\",\n \"client_id\": 31006,\n \"internal\": false,\n \"budget\": null,\n \"fixed_price\": \"1000.00\",\n \"rate\": null,\n \"billing_method\": null,\n \"project_type\": \"fixed_price\",\n \"active\": true,\n \"complete\": false,\n \"sample\": false,\n \"created_at\": \"2019-04-19T18:22:06\",\n \"updated_at\": \"2019-04-19T18:22:06\",\n \"logged_duration\": null,\n \"services\": [],\n \"billed_amount\": \"0.00\",\n \"billed_status\": \"unbilled\",\n \"group_id\": 4951006\n },\n {\n \"id\": 2980870,\n \"title\": \"Hiking Guide\",\n \"description\": null,\n \"due_date\": \"2019-05-20\",\n \"client_id\": 31006,\n \"internal\": false,\n \"budget\": null,\n \"fixed_price\": \"500.00\",\n \"rate\": null,\n \"billing_method\": null,\n \"project_type\": \"fixed_price\",\n \"active\": true,\n \"complete\": false,\n \"sample\": false,\n \"created_at\": \"2019-04-19T18:21:11\",\n \"updated_at\": \"2019-04-19T18:21:11\",\n \"logged_duration\": null,\n \"services\": [],\n \"billed_amount\": \"0.00\",\n \"billed_status\": \"unbilled\",\n \"group_id\": 4951004\n },\n {\n \"id\": 2976412,\n \"title\": \"Very Custom Computer thing\",\n \"description\": null,\n \"due_date\": null,\n \"client_id\": 31006,\n \"internal\": false,\n \"budget\": null,\n \"fixed_price\": null,\n \"rate\": null,\n \"billing_method\": \"project_rate\",\n \"project_type\": \"fixed_price\",\n \"active\": true,\n \"complete\": false,\n \"sample\": false,\n \"created_at\": \"2019-04-18T13:43:31\",\n \"updated_at\": \"2019-04-18T13:43:31\",\n \"logged_duration\": null,\n \"services\": [\n {\n \"business_id\": 1966214,\n \"id\": 3575792,\n \"name\": \"Computer Hardware\",\n \"billable\": true,\n \"vis_state\": 0\n }\n ],\n \"billed_amount\": \"0.00\",\n \"billed_status\": \"unbilled\",\n \"group_id\": 4942784\n }\n ]\n}"
}
]
}
