Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"
CkHttp_SetRequestHeader $http "Content-Type" "application/json"
set sbResponseBody [new_CkStringBuilder]
set success [CkHttp_QuickGetSb $http "https://api.freshbooks.com/auth/api/v1/users/business/{{businessId}}" $sbResponseBody]
if {$success == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
exit
}
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttp_lastHeader $http]
puts "Failed."
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "response": {
# "id": 1966214,
# "name": "Postman Sandbox",
# "account_id": "wkMd2g",
# "business_group": {
# "id": 4942664,
# "category": "business",
# "members": [
# {
# "id": 6446238,
# "group_id": 4942664,
# "role": "business_partner",
# "identity_id": 37256,
# "first_name": "Marshall",
# "last_name": "Johnston",
# "email": "api.freshbooks@gmail.com",
# "company": "Postman Sandbox",
# "business_id": 1966214,
# "unacknowledged_change": false,
# "active": true
# },
# {
# "id": 6475824,
# "group_id": 4942664,
# "role": "business_accountant",
# "identity_id": 75537,
# "first_name": "Marshall",
# "last_name": "Johnston",
# "email": "api.freshbooks@gmail.com",
# "company": "Postman Sandbox",
# "business_id": 1966214,
# "unacknowledged_change": false,
# "active": true
# },
# {
# "id": 6446130,
# "group_id": 4942664,
# "role": "owner",
# "identity_id": 1882548,
# "first_name": "Ryan",
# "last_name": "Marr",
# "email": "api.freshbooks@gmail.com",
# "company": "Postman Sandbox",
# "business_id": 1966214,
# "unacknowledged_change": false,
# "active": true
# }
# ]
# },
# "date_format": "mm/dd/yyyy",
# "address": {
# "id": 2421054,
# "street": null,
# "city": null,
# "province": null,
# "country": "Canada",
# "postal_code": null
# },
# "phone_number": null,
# "business_clients": [
# ]
# }
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set Date_format [new_CkDtObj]
set Id [CkJsonObject_IntOf $jResp "response.id"]
set Name [CkJsonObject_stringOf $jResp "response.name"]
set Account_id [CkJsonObject_stringOf $jResp "response.account_id"]
set Business_groupId [CkJsonObject_IntOf $jResp "response.business_group.id"]
set Category [CkJsonObject_stringOf $jResp "response.business_group.category"]
CkJsonObject_DtOf $jResp "response.date_format" 0 $Date_format
set AddressId [CkJsonObject_IntOf $jResp "response.address.id"]
set Street [CkJsonObject_stringOf $jResp "response.address.street"]
set City [CkJsonObject_stringOf $jResp "response.address.city"]
set Province [CkJsonObject_stringOf $jResp "response.address.province"]
set Country [CkJsonObject_stringOf $jResp "response.address.country"]
set Postal_code [CkJsonObject_stringOf $jResp "response.address.postal_code"]
set Phone_number [CkJsonObject_stringOf $jResp "response.phone_number"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "response.business_group.members"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set id [CkJsonObject_IntOf $jResp "response.business_group.members[i].id"]
set group_id [CkJsonObject_IntOf $jResp "response.business_group.members[i].group_id"]
set role [CkJsonObject_stringOf $jResp "response.business_group.members[i].role"]
set identity_id [CkJsonObject_IntOf $jResp "response.business_group.members[i].identity_id"]
set first_name [CkJsonObject_stringOf $jResp "response.business_group.members[i].first_name"]
set last_name [CkJsonObject_stringOf $jResp "response.business_group.members[i].last_name"]
set email [CkJsonObject_stringOf $jResp "response.business_group.members[i].email"]
set company [CkJsonObject_stringOf $jResp "response.business_group.members[i].company"]
set business_id [CkJsonObject_IntOf $jResp "response.business_group.members[i].business_id"]
set unacknowledged_change [CkJsonObject_BoolOf $jResp "response.business_group.members[i].unacknowledged_change"]
set active [CkJsonObject_BoolOf $jResp "response.business_group.members[i].active"]
set i [expr $i + 1]
}
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "response.business_clients"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
delete_CkDtObj $Date_format
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
-H "Content-Type: application/json"
https://api.freshbooks.com/auth/api/v1/users/business/{{businessId}}
Postman Collection Item JSON
{
"name": "List Staff",
"event": [
{
"listen": "test",
"script": {
"exec": [
"let jsonData = JSON.parse(responseBody);",
"pm.environment.set(\"identityId\", jsonData.response.business_group.members[0].identity_id)"
],
"type": "text/javascript"
}
}
],
"request": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"url": {
"raw": "https://api.freshbooks.com/auth/api/v1/users/business/{{businessId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"auth",
"api",
"v1",
"users",
"business",
"{{businessId}}"
]
}
},
"response": [
{
"name": "List Staff",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Content-Type",
"type": "text",
"value": "application/json"
}
],
"url": {
"raw": "https://api.freshbooks.com/auth/api/v1/users/business/{{businessId}}",
"protocol": "https",
"host": [
"api",
"freshbooks",
"com"
],
"path": [
"auth",
"api",
"v1",
"users",
"business",
"{{businessId}}"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "nginx"
},
{
"key": "Content-Type",
"value": "application/json; charset=utf-8"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-Download-Options",
"value": "noopen"
},
{
"key": "X-Permitted-Cross-Domain-Policies",
"value": "none"
},
{
"key": "Referrer-Policy",
"value": "strict-origin-when-cross-origin"
},
{
"key": "ETag",
"value": "W/\"8cc492fe0ab5fdbd7afc687dfe9781bf\""
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "X-Request-Id",
"value": "16b4dc9f-df36-4050-aa07-03208a1d1e74"
},
{
"key": "X-Runtime",
"value": "0.036737"
},
{
"key": "X-NewRelic-App-Data",
"value": "PxQBWV5TCBABVlVSBAUHUFQTGhEhCQ0WQg1UDl1KG39aAV0NVBZSEAEZZQAFCBdyUxAIDVl1XhUUUEJQClxZMF8XTAtWXw4IYQpMFVQyVhZLVVYNCkEUAx5UTVIZAQRRUwkPAlJQUFQJUglaDQ0YHwJJG1gGVwYHUgYPAgBVWlIEXABAag=="
},
{
"key": "X-RateLimit-Limit",
"value": "20"
},
{
"key": "X-RateLimit-Remaining",
"value": "0"
},
{
"key": "X-RateLimit-Reset",
"value": "1557346308"
},
{
"key": "Retry-After",
"value": "57"
},
{
"key": "Access-Control-Allow-Origin",
"value": "*"
},
{
"key": "Expires",
"value": "Tue, 08 May 2018 20:10:50 GMT"
},
{
"key": "Content-Encoding",
"value": "gzip"
},
{
"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": "Transfer-Encoding",
"value": "chunked"
},
{
"key": "Date",
"value": "Wed, 08 May 2019 20:10:50 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": "Vary",
"value": "Accept-Encoding"
},
{
"key": "Country",
"value": "CA"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=31536000; includeSubDomains; preload"
}
],
"cookie": [
],
"body": "{\n \"response\": {\n \"id\": 1966214,\n \"name\": \"Postman Sandbox\",\n \"account_id\": \"wkMd2g\",\n \"business_group\": {\n \"id\": 4942664,\n \"category\": \"business\",\n \"members\": [\n {\n \"id\": 6446238,\n \"group_id\": 4942664,\n \"role\": \"business_partner\",\n \"identity_id\": 37256,\n \"first_name\": \"Marshall\",\n \"last_name\": \"Johnston\",\n \"email\": \"api.freshbooks@gmail.com\",\n \"company\": \"Postman Sandbox\",\n \"business_id\": 1966214,\n \"unacknowledged_change\": false,\n \"active\": true\n },\n {\n \"id\": 6475824,\n \"group_id\": 4942664,\n \"role\": \"business_accountant\",\n \"identity_id\": 75537,\n \"first_name\": \"Marshall\",\n \"last_name\": \"Johnston\",\n \"email\": \"api.freshbooks@gmail.com\",\n \"company\": \"Postman Sandbox\",\n \"business_id\": 1966214,\n \"unacknowledged_change\": false,\n \"active\": true\n },\n {\n \"id\": 6446130,\n \"group_id\": 4942664,\n \"role\": \"owner\",\n \"identity_id\": 1882548,\n \"first_name\": \"Ryan\",\n \"last_name\": \"Marr\",\n \"email\": \"api.freshbooks@gmail.com\",\n \"company\": \"Postman Sandbox\",\n \"business_id\": 1966214,\n \"unacknowledged_change\": false,\n \"active\": true\n }\n ]\n },\n \"date_format\": \"mm/dd/yyyy\",\n \"address\": {\n \"id\": 2421054,\n \"street\": null,\n \"city\": null,\n \"province\": null,\n \"country\": \"Canada\",\n \"postal_code\": null\n },\n \"phone_number\": null,\n \"business_clients\": []\n }\n}"
}
]
}
