Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lnId
LOCAL lcTitle
LOCAL lcDescription
LOCAL lcDue_date
LOCAL lnClient_id
LOCAL lnInternal
LOCAL lcBudget
LOCAL lcFixed_price
LOCAL lcRate
LOCAL lcBilling_method
LOCAL lcProject_type
LOCAL lnActive
LOCAL lnComplete
LOCAL lnSample
LOCAL lcCreated_at
LOCAL lcUpdated_at
LOCAL lcLogged_duration
LOCAL lcBilled_amount
LOCAL lcBilled_status
LOCAL lnGroup_id
LOCAL j
LOCAL lnCount_j
LOCAL lnBusiness_id
LOCAL lcName
LOCAL lnBillable
LOCAL lnVis_state
LOCAL lnTotal
LOCAL lnPer_page
LOCAL lnPage
LOCAL lnPages
LOCAL i
LOCAL lnCount_i
* This example assumes the Chilkat API to have been previously unlocked.
* See Global Unlock Sample for sample code.
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
* Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
lnSuccess = loHttp.QuickGetSb("https://api.freshbooks.com/projects/business/{{businessId}}/projects",loSbResponseBody)
IF (lnSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loSbResponseBody
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loHttp.LastHeader
? "Failed."
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
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
lnTotal = loJResp.IntOf("meta.total")
lnPer_page = loJResp.IntOf("meta.per_page")
lnPage = loJResp.IntOf("meta.page")
lnPages = loJResp.IntOf("meta.pages")
i = 0
lnCount_i = loJResp.SizeOfArray("meta.sort")
DO WHILE i < lnCount_i
loJResp.I = i
i = i + 1
ENDDO
i = 0
lnCount_i = loJResp.SizeOfArray("projects")
DO WHILE i < lnCount_i
loJResp.I = i
lnId = loJResp.IntOf("projects[i].id")
lcTitle = loJResp.StringOf("projects[i].title")
lcDescription = loJResp.StringOf("projects[i].description")
lcDue_date = loJResp.StringOf("projects[i].due_date")
lnClient_id = loJResp.IntOf("projects[i].client_id")
lnInternal = loJResp.BoolOf("projects[i].internal")
lcBudget = loJResp.StringOf("projects[i].budget")
lcFixed_price = loJResp.StringOf("projects[i].fixed_price")
lcRate = loJResp.StringOf("projects[i].rate")
lcBilling_method = loJResp.StringOf("projects[i].billing_method")
lcProject_type = loJResp.StringOf("projects[i].project_type")
lnActive = loJResp.BoolOf("projects[i].active")
lnComplete = loJResp.BoolOf("projects[i].complete")
lnSample = loJResp.BoolOf("projects[i].sample")
lcCreated_at = loJResp.StringOf("projects[i].created_at")
lcUpdated_at = loJResp.StringOf("projects[i].updated_at")
lcLogged_duration = loJResp.StringOf("projects[i].logged_duration")
lcBilled_amount = loJResp.StringOf("projects[i].billed_amount")
lcBilled_status = loJResp.StringOf("projects[i].billed_status")
lnGroup_id = loJResp.IntOf("projects[i].group_id")
j = 0
lnCount_j = loJResp.SizeOfArray("projects[i].services")
DO WHILE j < lnCount_j
loJResp.J = j
lnBusiness_id = loJResp.IntOf("projects[i].services[j].business_id")
lnId = loJResp.IntOf("projects[i].services[j].id")
lcName = loJResp.StringOf("projects[i].services[j].name")
lnBillable = loJResp.BoolOf("projects[i].services[j].billable")
lnVis_state = loJResp.IntOf("projects[i].services[j].vis_state")
j = j + 1
ENDDO
i = i + 1
ENDDO
RELEASE loHttp
RELEASE loSbResponseBody
RELEASE loJResp
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}"
}
]
}
