Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("CkHttp")
// Adds the "Authorization: Bearer <access_token>" header.
loHttp.AuthToken = "<access_token>"
loSbResponseBody = createobject("CkStringBuilder")
llSuccess = loHttp.QuickGetSb("https://api.freshbooks.com/projects/business/{{businessId}}/projects/{{projectId}}",loSbResponseBody)
if (llSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loSbResponseBody
return
endif
loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.
? "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
return
endif
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "project": {
// "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",
// "retainer_id": null,
// "group": {
// "id": 4942784,
// "members": [
// {
// "id": 6446258,
// "identity_id": 1882548,
// "role": "owner",
// "first_name": "Ryan",
// "last_name": "Marr",
// "email": "api.freshbooks@freshbooks.com",
// "company": "Postman Sandbox",
// "active": true
// }
// ],
// "pending_invitations": [
// ]
// }
// },
// "abilities": [
// {
// "name": "can_edit",
// "value": true
// },
// {
// "name": "can_archive",
// "value": true
// },
// {
// "name": "can_generate_invoice",
// "value": true
// },
// {
// "name": "can_delete",
// "value": true
// },
// {
// "name": "can_invite_team_member",
// "value": true
// },
// {
// "name": "can_manage_services",
// "value": true
// },
// {
// "name": "can_edit_hourly_budget",
// "value": true
// },
// {
// "name": "can_view_fixed_price",
// "value": true
// },
// {
// "name": "can_edit_fixed_price",
// "value": true
// },
// {
// "name": "can_edit_end_date",
// "value": true
// },
// {
// "name": "can_edit_flat_rate",
// "value": true
// },
// {
// "name": "can_edit_project_type",
// "value": true
// },
// {
// "name": "can_edit_title",
// "value": true
// },
// {
// "name": "can_view_review_tab",
// "value": true
// },
// {
// "name": "can_view_discuss_tab",
// "value": false
// },
// {
// "name": "can_track_time",
// "value": true
// },
// {
// "name": "can_create_comment",
// "value": true
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
lnId = loJResp.IntOf("project.id")
lcTitle = loJResp.StringOf("project.title")
lcDescription = loJResp.StringOf("project.description")
lcDue_date = loJResp.StringOf("project.due_date")
lnClient_id = loJResp.IntOf("project.client_id")
llInternal = loJResp.BoolOf("project.internal")
lcBudget = loJResp.StringOf("project.budget")
lcFixed_price = loJResp.StringOf("project.fixed_price")
lcRate = loJResp.StringOf("project.rate")
lcBilling_method = loJResp.StringOf("project.billing_method")
lcProject_type = loJResp.StringOf("project.project_type")
llActive = loJResp.BoolOf("project.active")
llComplete = loJResp.BoolOf("project.complete")
llSample = loJResp.BoolOf("project.sample")
lcCreated_at = loJResp.StringOf("project.created_at")
lcUpdated_at = loJResp.StringOf("project.updated_at")
lcLogged_duration = loJResp.StringOf("project.logged_duration")
lcBilled_amount = loJResp.StringOf("project.billed_amount")
lcBilled_status = loJResp.StringOf("project.billed_status")
lcRetainer_id = loJResp.StringOf("project.retainer_id")
lnGroupId = loJResp.IntOf("project.group.id")
i = 0
lnCount_i = loJResp.SizeOfArray("project.services")
do while i < lnCount_i
loJResp.I = i
lnBusiness_id = loJResp.IntOf("project.services[i].business_id")
lnId = loJResp.IntOf("project.services[i].id")
lcName = loJResp.StringOf("project.services[i].name")
llBillable = loJResp.BoolOf("project.services[i].billable")
lnVis_state = loJResp.IntOf("project.services[i].vis_state")
i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("project.group.members")
do while i < lnCount_i
loJResp.I = i
lnId = loJResp.IntOf("project.group.members[i].id")
lnIdentity_id = loJResp.IntOf("project.group.members[i].identity_id")
lcRole = loJResp.StringOf("project.group.members[i].role")
lcFirst_name = loJResp.StringOf("project.group.members[i].first_name")
lcLast_name = loJResp.StringOf("project.group.members[i].last_name")
lcEmail = loJResp.StringOf("project.group.members[i].email")
lcCompany = loJResp.StringOf("project.group.members[i].company")
llActive = loJResp.BoolOf("project.group.members[i].active")
i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("project.group.pending_invitations")
do while i < lnCount_i
loJResp.I = i
i = i + 1
enddo
i = 0
lnCount_i = loJResp.SizeOfArray("abilities")
do while i < lnCount_i
loJResp.I = i
lcName = loJResp.StringOf("abilities[i].name")
llValue = loJResp.BoolOf("abilities[i].value")
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/{{projectId}}
Postman Collection Item JSON
{
"name": "Single Project",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.freshbooks.com/projects/business/{{businessId}}/projects/{{projectId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"projects",
"business",
"{{businessId}}",
"projects",
"{{projectId}}"
]
}
},
"response": [
{
"name": "Single Project",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "https://api.freshbooks.com/projects/business/{{businessId}}/projects/{{projectId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"projects",
"business",
"{{businessId}}",
"projects",
"{{projectId}}"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/vnd.api+json"
},
{
"key": "X-Version",
"value": "1905.7.0"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVllUBAQOU10TGhE1AwE2QgNWEVlbQFtcCxYnRA9QFg1ZWU4FDFZFVRYSBxlDUhULRERQBxVNEkINUgdbTBpAVhZWFEMCVlgURFgLAwBMERxUTVIZAAFUXAIBBFZVVFcJUw1XCg8YHwJJG1hUUABaBwcHVFMFDVEEUFVAG1dWChdUaw=="
},
{
"key": "X-RateLimit-Limit",
"value": "20"
},
{
"key": "X-RateLimit-Remaining",
"value": "14"
},
{
"key": "X-RateLimit-Reset",
"value": "1557345999"
},
{
"key": "Retry-After",
"value": "60"
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Tue, 08 May 2018 20:05:38 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": "1653"
},
{
"key": "Date",
"value": "Wed, 08 May 2019 20:05:38 GMT"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "X-Served-By",
"value": "cache-mdw17361-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 \"project\": {\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 \"retainer_id\": null,\n \"group\": {\n \"id\": 4942784,\n \"members\": [\n {\n \"id\": 6446258,\n \"identity_id\": 1882548,\n \"role\": \"owner\",\n \"first_name\": \"Ryan\",\n \"last_name\": \"Marr\",\n \"email\": \"api.freshbooks@freshbooks.com\",\n \"company\": \"Postman Sandbox\",\n \"active\": true\n }\n ],\n \"pending_invitations\": []\n }\n },\n \"abilities\": [\n {\n \"name\": \"can_edit\",\n \"value\": true\n },\n {\n \"name\": \"can_archive\",\n \"value\": true\n },\n {\n \"name\": \"can_generate_invoice\",\n \"value\": true\n },\n {\n \"name\": \"can_delete\",\n \"value\": true\n },\n {\n \"name\": \"can_invite_team_member\",\n \"value\": true\n },\n {\n \"name\": \"can_manage_services\",\n \"value\": true\n },\n {\n \"name\": \"can_edit_hourly_budget\",\n \"value\": true\n },\n {\n \"name\": \"can_view_fixed_price\",\n \"value\": true\n },\n {\n \"name\": \"can_edit_fixed_price\",\n \"value\": true\n },\n {\n \"name\": \"can_edit_end_date\",\n \"value\": true\n },\n {\n \"name\": \"can_edit_flat_rate\",\n \"value\": true\n },\n {\n \"name\": \"can_edit_project_type\",\n \"value\": true\n },\n {\n \"name\": \"can_edit_title\",\n \"value\": true\n },\n {\n \"name\": \"can_view_review_tab\",\n \"value\": true\n },\n {\n \"name\": \"can_view_discuss_tab\",\n \"value\": false\n },\n {\n \"name\": \"can_track_time\",\n \"value\": true\n },\n {\n \"name\": \"can_create_comment\",\n \"value\": true\n }\n ]\n}"
}
]
}
