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://domain.com/crm/v2.1/Accounts/4150868000004395059",$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)
; {
; "data": [
; {
; "Owner": {
; "name": "Patricia Boyle",
; "id": "4150868000000225013",
; "email": "patricia.ss@zylker.com"
; },
; "$currency_symbol": "DA",
; "Account_Type": "Analyst",
; "SIC_Code": null,
; "$sharing_permission": "full_access",
; "Last_Activity_Time": "2021-03-09T13:31:06+05:30",
; "Industry": null,
; "Account_Site": null,
; "$state": "save",
; "$process_flow": false,
; "Exchange_Rate": 3,
; "Currency": "DZD",
; "Billing_Country": null,
; "id": "4150868000004395059",
; "$approved": true,
; "$approval": {
; "delegate": false,
; "approve": false,
; "reject": false,
; "resubmit": false
; },
; "Billing_Street": null,
; "Created_Time": "2021-01-22T10:44:07+05:30",
; "$editable": true,
; "Billing_Code": null,
; "Shipping_City": null,
; "Shipping_Country": null,
; "Shipping_Code": null,
; "Billing_City": null,
; "Created_By": {
; "name": "Patricia Boyle",
; "id": "4150868000000225013",
; "email": "patricia.ss@zylker.com"
; },
; "Annual_Revenue": null,
; "Stakeholders": [
; ],
; "Shipping_Street": null,
; "Ownership": null,
; "Description": null,
; "Rating": null,
; "Shipping_State": null,
; "$review_process": {
; "approve": false,
; "reject": false,
; "resubmit": false
; },
; "Website": null,
; "Employees": null,
; "$canvas_id": null,
; "Record_Image": null,
; "Modified_By": {
; "name": "Patricia Boyle",
; "id": "4150868000000225013",
; "email": "patricia.ss@zylker.com"
; },
; "$review": null,
; "Phone": null,
; "Account_Name": "Sample Account",
; "Account_Number": "0",
; "multiuserlookup": [
; ],
; "Ticker_Symbol": null,
; "Modified_Time": "2021-01-25T14:09:56+05:30",
; "Territories": [
; {
; "$assigned": "automatically",
; "$assigned_time": "2021-01-22T10:44:07+05:30",
; "id": "4150868000000264087",
; "$assigned_by": null,
; "Name": "Sample for API testing"
; },
; {
; "$assigned": "automatically",
; "$assigned_time": "2021-01-22T10:44:07+05:30",
; "id": "4150868000001390007",
; "$assigned_by": null,
; "Name": "sample"
; },
; {
; "$assigned": "automatically",
; "$assigned_time": "2021-01-22T10:44:07+05:30",
; "id": "4150868000003259003",
; "$assigned_by": null,
; "Name": "mass delete"
; },
; {
; "$assigned": "automatically",
; "$assigned_time": "2021-03-04T12:18:55+05:30",
; "id": "4150868000004822544",
; "$assigned_by": null,
; "Name": "leads"
; },
; {
; "$assigned": "manually",
; "$assigned_time": "2021-04-29T17:27:28+05:30",
; "id": "4150868000005232017",
; "$assigned_by": {
; "name": "Patricia Boyle",
; "id": "4150868000000225013"
; },
; "Name": "sample 8"
; }
; ],
; "$orchestration": false,
; "Parent_Account": null,
; "Contacts": null,
; "Layout": {
; "name": "Standard",
; "id": "4150868000000091029"
; },
; "$in_merge": false,
; "Contact_Details": [
; ],
; "Total": null,
; "Billing_State": null,
; "Tag": [
; ],
; "Fax": null,
; "$approval_state": "approved",
; "$has_more": {
; "multiuserlookup": false
; }
; }
; ]
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Local $sName
Local $sId
Local $sV_Email
Local $sScurrency_symbol
Local $sAccount_Type
Local $sSIC_Code
Local $sSsharing_permission
Local $sLast_Activity_Time
Local $sIndustry
Local $sAccount_Site
Local $sSstate
Local $bSprocess_flow
Local $iExchange_Rate
Local $sV_Currency
Local $sBilling_Country
Local $sId
Local $bSapproved
Local $bDelegate
Local $bApprove
Local $bReject
Local $bResubmit
Local $sBilling_Street
Local $sCreated_Time
Local $bSeditable
Local $sBilling_Code
Local $sShipping_City
Local $sShipping_Country
Local $sShipping_Code
Local $sBilling_City
Local $sCreated_ByName
Local $sCreated_ById
Local $sCreated_ByEmail
Local $sAnnual_Revenue
Local $sShipping_Street
Local $sOwnership
Local $sDescription
Local $sRating
Local $sShipping_State
Local $bSreview_processApprove
Local $bSreview_processReject
Local $bSreview_processResubmit
Local $sWebsite
Local $sEmployees
Local $sScanvas_id
Local $sRecord_Image
Local $sModified_ByName
Local $sModified_ById
Local $sModified_ByEmail
Local $sSreview
Local $sPhone
Local $sAccount_Name
Local $sAccount_Number
Local $sTicker_Symbol
Local $sModified_Time
Local $bSorchestration
Local $sParent_Account
Local $sContacts
Local $sLayoutName
Local $sLayoutId
Local $bSin_merge
Local $sTotal
Local $sBilling_State
Local $sFax
Local $sSapproval_state
Local $bMultiuserlookup
Local $iJ
Local $iCount_j
Local $sSassigned
Local $sSassigned_time
Local $sSassigned_by
Local $sSassigned_byName
Local $sSassigned_byId
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("data")
While $i < $iCount_i
$oJResp.I = $i
$sName = $oJResp.StringOf("data[i].Owner.name")
$sId = $oJResp.StringOf("data[i].Owner.id")
$sV_Email = $oJResp.StringOf("data[i].Owner.email")
$sScurrency_symbol = $oJResp.StringOf("data[i].$currency_symbol")
$sAccount_Type = $oJResp.StringOf("data[i].Account_Type")
$sSIC_Code = $oJResp.StringOf("data[i].SIC_Code")
$sSsharing_permission = $oJResp.StringOf("data[i].$sharing_permission")
$sLast_Activity_Time = $oJResp.StringOf("data[i].Last_Activity_Time")
$sIndustry = $oJResp.StringOf("data[i].Industry")
$sAccount_Site = $oJResp.StringOf("data[i].Account_Site")
$sSstate = $oJResp.StringOf("data[i].$state")
$bSprocess_flow = $oJResp.BoolOf("data[i].$process_flow")
$iExchange_Rate = $oJResp.IntOf("data[i].Exchange_Rate")
$sV_Currency = $oJResp.StringOf("data[i].Currency")
$sBilling_Country = $oJResp.StringOf("data[i].Billing_Country")
$sId = $oJResp.StringOf("data[i].id")
$bSapproved = $oJResp.BoolOf("data[i].$approved")
$bDelegate = $oJResp.BoolOf("data[i].$approval.delegate")
$bApprove = $oJResp.BoolOf("data[i].$approval.approve")
$bReject = $oJResp.BoolOf("data[i].$approval.reject")
$bResubmit = $oJResp.BoolOf("data[i].$approval.resubmit")
$sBilling_Street = $oJResp.StringOf("data[i].Billing_Street")
$sCreated_Time = $oJResp.StringOf("data[i].Created_Time")
$bSeditable = $oJResp.BoolOf("data[i].$editable")
$sBilling_Code = $oJResp.StringOf("data[i].Billing_Code")
$sShipping_City = $oJResp.StringOf("data[i].Shipping_City")
$sShipping_Country = $oJResp.StringOf("data[i].Shipping_Country")
$sShipping_Code = $oJResp.StringOf("data[i].Shipping_Code")
$sBilling_City = $oJResp.StringOf("data[i].Billing_City")
$sCreated_ByName = $oJResp.StringOf("data[i].Created_By.name")
$sCreated_ById = $oJResp.StringOf("data[i].Created_By.id")
$sCreated_ByEmail = $oJResp.StringOf("data[i].Created_By.email")
$sAnnual_Revenue = $oJResp.StringOf("data[i].Annual_Revenue")
$sShipping_Street = $oJResp.StringOf("data[i].Shipping_Street")
$sOwnership = $oJResp.StringOf("data[i].Ownership")
$sDescription = $oJResp.StringOf("data[i].Description")
$sRating = $oJResp.StringOf("data[i].Rating")
$sShipping_State = $oJResp.StringOf("data[i].Shipping_State")
$bSreview_processApprove = $oJResp.BoolOf("data[i].$review_process.approve")
$bSreview_processReject = $oJResp.BoolOf("data[i].$review_process.reject")
$bSreview_processResubmit = $oJResp.BoolOf("data[i].$review_process.resubmit")
$sWebsite = $oJResp.StringOf("data[i].Website")
$sEmployees = $oJResp.StringOf("data[i].Employees")
$sScanvas_id = $oJResp.StringOf("data[i].$canvas_id")
$sRecord_Image = $oJResp.StringOf("data[i].Record_Image")
$sModified_ByName = $oJResp.StringOf("data[i].Modified_By.name")
$sModified_ById = $oJResp.StringOf("data[i].Modified_By.id")
$sModified_ByEmail = $oJResp.StringOf("data[i].Modified_By.email")
$sSreview = $oJResp.StringOf("data[i].$review")
$sPhone = $oJResp.StringOf("data[i].Phone")
$sAccount_Name = $oJResp.StringOf("data[i].Account_Name")
$sAccount_Number = $oJResp.StringOf("data[i].Account_Number")
$sTicker_Symbol = $oJResp.StringOf("data[i].Ticker_Symbol")
$sModified_Time = $oJResp.StringOf("data[i].Modified_Time")
$bSorchestration = $oJResp.BoolOf("data[i].$orchestration")
$sParent_Account = $oJResp.StringOf("data[i].Parent_Account")
$sContacts = $oJResp.StringOf("data[i].Contacts")
$sLayoutName = $oJResp.StringOf("data[i].Layout.name")
$sLayoutId = $oJResp.StringOf("data[i].Layout.id")
$bSin_merge = $oJResp.BoolOf("data[i].$in_merge")
$sTotal = $oJResp.StringOf("data[i].Total")
$sBilling_State = $oJResp.StringOf("data[i].Billing_State")
$sFax = $oJResp.StringOf("data[i].Fax")
$sSapproval_state = $oJResp.StringOf("data[i].$approval_state")
$bMultiuserlookup = $oJResp.BoolOf("data[i].$has_more.multiuserlookup")
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("data[i].Stakeholders")
While $iJ < $iCount_j
$oJResp.J = $iJ
$iJ = $iJ + 1
Wend
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("data[i].multiuserlookup")
While $iJ < $iCount_j
$oJResp.J = $iJ
$iJ = $iJ + 1
Wend
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("data[i].Territories")
While $iJ < $iCount_j
$oJResp.J = $iJ
$sSassigned = $oJResp.StringOf("data[i].Territories[j].$assigned")
$sSassigned_time = $oJResp.StringOf("data[i].Territories[j].$assigned_time")
$sId = $oJResp.StringOf("data[i].Territories[j].id")
$sSassigned_by = $oJResp.StringOf("data[i].Territories[j].$assigned_by")
$sName = $oJResp.StringOf("data[i].Territories[j].Name")
$sSassigned_byName = $oJResp.StringOf("data[i].Territories[j].$assigned_by.name")
$sSassigned_byId = $oJResp.StringOf("data[i].Territories[j].$assigned_by.id")
$iJ = $iJ + 1
Wend
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("data[i].Contact_Details")
While $iJ < $iCount_j
$oJResp.J = $iJ
$iJ = $iJ + 1
Wend
$iJ = 0
$iCount_j = $oJResp.SizeOfArray("data[i].Tag")
While $iJ < $iCount_j
$oJResp.J = $iJ
$iJ = $iJ + 1
Wend
$i = $i + 1
Wend
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
https://domain.com/crm/v2.1/Accounts/4150868000004395059
Postman Collection Item JSON
{
"name": "Get Territories Assigned",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{access-token}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/Accounts/4150868000004395059",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"Accounts",
"4150868000004395059"
]
},
"description": "To get the details of the territories assigned to a record."
},
"response": [
{
"name": "SUCCESS RESPONSE",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/Accounts/4150868000004395059",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"Accounts",
"4150868000004395059"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Mon, 03 May 2021 11:27:25 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Referrer-Policy",
"value": "strict-origin"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "Set-Cookie",
"value": "listview_enabled=true;Path=/"
},
{
"key": "X-ACCESSTOKEN-RESET",
"value": "2021-05-03T17:48:32+05:30"
},
{
"key": "clientVersion",
"value": "4000204"
},
{
"key": "clientsubVersion",
"value": "9875f452294f1c73e02cebb497ee077e"
},
{
"key": "Content-Disposition",
"value": "attachment; filename=response.json"
},
{
"key": "vary",
"value": "accept-encoding"
},
{
"key": "Content-Encoding",
"value": "gzip"
},
{
"key": "Content-Language",
"value": "en-US"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=63072000"
}
],
"cookie": [
],
"body": "{\n \"data\": [\n {\n \"Owner\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"4150868000000225013\",\n \"email\": \"patricia.ss@zylker.com\"\n },\n \"$currency_symbol\": \"DA\",\n \"Account_Type\": \"Analyst\",\n \"SIC_Code\": null,\n \"$sharing_permission\": \"full_access\",\n \"Last_Activity_Time\": \"2021-03-09T13:31:06+05:30\",\n \"Industry\": null,\n \"Account_Site\": null,\n \"$state\": \"save\",\n \"$process_flow\": false,\n \"Exchange_Rate\": 3,\n \"Currency\": \"DZD\",\n \"Billing_Country\": null,\n \"id\": \"4150868000004395059\",\n \"$approved\": true,\n \"$approval\": {\n \"delegate\": false,\n \"approve\": false,\n \"reject\": false,\n \"resubmit\": false\n },\n \"Billing_Street\": null,\n \"Created_Time\": \"2021-01-22T10:44:07+05:30\",\n \"$editable\": true,\n \"Billing_Code\": null,\n \"Shipping_City\": null,\n \"Shipping_Country\": null,\n \"Shipping_Code\": null,\n \"Billing_City\": null,\n \"Created_By\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"4150868000000225013\",\n \"email\": \"patricia.ss@zylker.com\"\n },\n \"Annual_Revenue\": null,\n \"Stakeholders\": [],\n \"Shipping_Street\": null,\n \"Ownership\": null,\n \"Description\": null,\n \"Rating\": null,\n \"Shipping_State\": null,\n \"$review_process\": {\n \"approve\": false,\n \"reject\": false,\n \"resubmit\": false\n },\n \"Website\": null,\n \"Employees\": null,\n \"$canvas_id\": null,\n \"Record_Image\": null,\n \"Modified_By\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"4150868000000225013\",\n \"email\": \"patricia.ss@zylker.com\"\n },\n \"$review\": null,\n \"Phone\": null,\n \"Account_Name\": \"Sample Account\",\n \"Account_Number\": \"0\",\n \"multiuserlookup\": [],\n \"Ticker_Symbol\": null,\n \"Modified_Time\": \"2021-01-25T14:09:56+05:30\",\n \"Territories\": [\n {\n \"$assigned\": \"automatically\",\n \"$assigned_time\": \"2021-01-22T10:44:07+05:30\",\n \"id\": \"4150868000000264087\",\n \"$assigned_by\": null,\n \"Name\": \"Sample for API testing\"\n },\n {\n \"$assigned\": \"automatically\",\n \"$assigned_time\": \"2021-01-22T10:44:07+05:30\",\n \"id\": \"4150868000001390007\",\n \"$assigned_by\": null,\n \"Name\": \"sample\"\n },\n {\n \"$assigned\": \"automatically\",\n \"$assigned_time\": \"2021-01-22T10:44:07+05:30\",\n \"id\": \"4150868000003259003\",\n \"$assigned_by\": null,\n \"Name\": \"mass delete\"\n },\n {\n \"$assigned\": \"automatically\",\n \"$assigned_time\": \"2021-03-04T12:18:55+05:30\",\n \"id\": \"4150868000004822544\",\n \"$assigned_by\": null,\n \"Name\": \"leads\"\n },\n {\n \"$assigned\": \"manually\",\n \"$assigned_time\": \"2021-04-29T17:27:28+05:30\",\n \"id\": \"4150868000005232017\",\n \"$assigned_by\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"4150868000000225013\"\n },\n \"Name\": \"sample 8\"\n }\n ],\n \"$orchestration\": false,\n \"Parent_Account\": null,\n \"Contacts\": null,\n \"Layout\": {\n \"name\": \"Standard\",\n \"id\": \"4150868000000091029\"\n },\n \"$in_merge\": false,\n \"Contact_Details\": [],\n \"Total\": null,\n \"Billing_State\": null,\n \"Tag\": [],\n \"Fax\": null,\n \"$approval_state\": \"approved\",\n \"$has_more\": {\n \"multiuserlookup\": false\n }\n }\n ]\n}"
},
{
"name": "INVALID_REQUEST_METHOD",
"originalRequest": {
"method": "POST",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/Accounts/{{account_id}}",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"Accounts",
"{{account_id}}"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Mon, 03 May 2021 11:28:39 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "124"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "X-Frame-Options",
"value": "deny"
},
{
"key": "X-Download-Options",
"value": "noopen"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
}
],
"cookie": [
],
"body": "{\n \"code\": \"INVALID_REQUEST_METHOD\",\n \"details\": {},\n \"message\": \"The http request method type is not a valid one\",\n \"status\": \"error\"\n}"
},
{
"name": "AUTHENTICATION_FAILURE",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/Accounts/4150868000004395059",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"Accounts",
"4150868000004395059"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Mon, 03 May 2021 11:29:27 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "98"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Referrer-Policy",
"value": "strict-origin"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-Download-Options",
"value": "noopen"
}
],
"cookie": [
],
"body": "{\n \"code\": \"AUTHENTICATION_FAILURE\",\n \"details\": {},\n \"message\": \"Authentication failed\",\n \"status\": \"error\"\n}"
},
{
"name": "OAUTH_SCOPE_MISMATCH",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/Accounts/4150868000004395059",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"Accounts",
"4150868000004395059"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Mon, 03 May 2021 11:30:20 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "113"
},
{
"key": "Connection",
"value": "keep-alive"
},
{
"key": "Referrer-Policy",
"value": "strict-origin"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "Pragma",
"value": "no-cache"
},
{
"key": "Cache-Control",
"value": "no-cache"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-Download-Options",
"value": "noopen"
}
],
"cookie": [
],
"body": "{\n \"code\": \"OAUTH_SCOPE_MISMATCH\",\n \"details\": {},\n \"message\": \"invalid oauth scope to access this URL\",\n \"status\": \"error\"\n}"
}
]
}
