Back to Collection Items
<?php
include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
$http = new CkHttp();
// Adds the "Authorization: Bearer <access_token>" header.
$http->put_AuthToken('<access_token>');
$sbResponseBody = new CkStringBuilder();
$success = $http->QuickGetSb('https://domain.com/crm/v2.1/Accounts',$sbResponseBody);
if ($success == false) {
print $http->lastErrorText() . "\n";
exit;
}
$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(false);
print 'Response Body:' . "\n";
print $jResp->emit() . "\n";
$respStatusCode = $http->get_LastStatus();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
print 'Response Header:' . "\n";
print $http->lastHeader() . "\n";
print 'Failed.' . "\n";
exit;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "data": [
// {
// "Owner": {
// "name": "patricia patricia",
// "id": "738964000000291009",
// "email": "patricia.ss@zylker.com"
// },
// "$currency_symbol": "Af",
// "Account_Type": null,
// "SIC_Code": null,
// "$sharing_permission": "full_access",
// "Last_Activity_Time": "2021-04-21T08:53:58+00:00",
// "Industry": null,
// "Account_Site": null,
// "$state": "save",
// "$process_flow": false,
// "Exchange_Rate": 1,
// "Billing_Country": null,
// "Currency": "AFN",
// "id": "738964000002058030",
// "$approved": true,
// "$approval": {
// "delegate": false,
// "approve": false,
// "reject": false,
// "resubmit": false
// },
// "Billing_Street": null,
// "Created_Time": "2021-04-21T08:53:58+00:00",
// "$editable": true,
// "Billing_Code": "1234",
// "Shipping_City": null,
// "Shipping_Country": null,
// "Shipping_Code": null,
// "Billing_City": null,
// "Created_By": {
// "name": "patricia patricia",
// "id": "738964000000291009",
// "email": "patricia.ss@zylker.com"
// },
// "Annual_Revenue": 1,
// "Shipping_Street": null,
// "territory_updated_time": null,
// "Ownership": null,
// "Description": null,
// "Rating": null,
// "Shipping_State": null,
// "$review_process": {
// "approve": false,
// "reject": false,
// "resubmit": false
// },
// "Website": "https://yaythisworked.com",
// "Employees": null,
// "Record_Image": null,
// "Modified_By": {
// "name": "patricia patricia",
// "id": "738964000000291009",
// "email": "patricia.ss@zylker.com"
// },
// "$review": null,
// "Phone": null,
// "Account_Name": "Zylker",
// "Account_Number": "0",
// "Ticker_Symbol": null,
// "Modified_Time": "2021-04-21T08:53:58+00:00",
// "Territories": [
// {
// "$assigned": "automatically",
// "$assigned_time": "2021-04-21T08:54:13+00:00",
// "id": "738964000001977355",
// "$assigned_by": null,
// "Name": "South Zone"
// }
// ],
// "$orchestration": false,
// "Parent_Account": null,
// "$in_merge": false,
// "Billing_State": "Colorado",
// "Tag": [
// ],
// "Fax": null,
// "$approval_state": "approved"
// }
// ],
// "info": {
// "per_page": 200,
// "count": 1,
// "page": 1,
// "more_records": false
// }
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
$Per_page = $jResp->IntOf('info.per_page');
$Count = $jResp->IntOf('info.count');
$Page = $jResp->IntOf('info.page');
$More_records = $jResp->BoolOf('info.more_records');
$i = 0;
$count_i = $jResp->SizeOfArray('data');
while ($i < $count_i) {
$jResp->put_I($i);
$Name = $jResp->stringOf('data[i].Owner.name');
$Id = $jResp->stringOf('data[i].Owner.id');
$v_Email = $jResp->stringOf('data[i].Owner.email');
$Scurrency_symbol = $jResp->stringOf('data[i].$currency_symbol');
$Account_Type = $jResp->stringOf('data[i].Account_Type');
$SIC_Code = $jResp->stringOf('data[i].SIC_Code');
$Ssharing_permission = $jResp->stringOf('data[i].$sharing_permission');
$Last_Activity_Time = $jResp->stringOf('data[i].Last_Activity_Time');
$Industry = $jResp->stringOf('data[i].Industry');
$Account_Site = $jResp->stringOf('data[i].Account_Site');
$Sstate = $jResp->stringOf('data[i].$state');
$Sprocess_flow = $jResp->BoolOf('data[i].$process_flow');
$Exchange_Rate = $jResp->IntOf('data[i].Exchange_Rate');
$Billing_Country = $jResp->stringOf('data[i].Billing_Country');
$v_Currency = $jResp->stringOf('data[i].Currency');
$id = $jResp->stringOf('data[i].id');
$Sapproved = $jResp->BoolOf('data[i].$approved');
$Delegate = $jResp->BoolOf('data[i].$approval.delegate');
$Approve = $jResp->BoolOf('data[i].$approval.approve');
$Reject = $jResp->BoolOf('data[i].$approval.reject');
$Resubmit = $jResp->BoolOf('data[i].$approval.resubmit');
$Billing_Street = $jResp->stringOf('data[i].Billing_Street');
$Created_Time = $jResp->stringOf('data[i].Created_Time');
$Seditable = $jResp->BoolOf('data[i].$editable');
$Billing_Code = $jResp->stringOf('data[i].Billing_Code');
$Shipping_City = $jResp->stringOf('data[i].Shipping_City');
$Shipping_Country = $jResp->stringOf('data[i].Shipping_Country');
$Shipping_Code = $jResp->stringOf('data[i].Shipping_Code');
$Billing_City = $jResp->stringOf('data[i].Billing_City');
$Created_ByName = $jResp->stringOf('data[i].Created_By.name');
$Created_ById = $jResp->stringOf('data[i].Created_By.id');
$Created_ByEmail = $jResp->stringOf('data[i].Created_By.email');
$Annual_Revenue = $jResp->IntOf('data[i].Annual_Revenue');
$Shipping_Street = $jResp->stringOf('data[i].Shipping_Street');
$territory_updated_time = $jResp->stringOf('data[i].territory_updated_time');
$Ownership = $jResp->stringOf('data[i].Ownership');
$Description = $jResp->stringOf('data[i].Description');
$Rating = $jResp->stringOf('data[i].Rating');
$Shipping_State = $jResp->stringOf('data[i].Shipping_State');
$Sreview_processApprove = $jResp->BoolOf('data[i].$review_process.approve');
$Sreview_processReject = $jResp->BoolOf('data[i].$review_process.reject');
$Sreview_processResubmit = $jResp->BoolOf('data[i].$review_process.resubmit');
$Website = $jResp->stringOf('data[i].Website');
$Employees = $jResp->stringOf('data[i].Employees');
$Record_Image = $jResp->stringOf('data[i].Record_Image');
$Modified_ByName = $jResp->stringOf('data[i].Modified_By.name');
$Modified_ById = $jResp->stringOf('data[i].Modified_By.id');
$Modified_ByEmail = $jResp->stringOf('data[i].Modified_By.email');
$Sreview = $jResp->stringOf('data[i].$review');
$Phone = $jResp->stringOf('data[i].Phone');
$Account_Name = $jResp->stringOf('data[i].Account_Name');
$Account_Number = $jResp->stringOf('data[i].Account_Number');
$Ticker_Symbol = $jResp->stringOf('data[i].Ticker_Symbol');
$Modified_Time = $jResp->stringOf('data[i].Modified_Time');
$Sorchestration = $jResp->BoolOf('data[i].$orchestration');
$Parent_Account = $jResp->stringOf('data[i].Parent_Account');
$Sin_merge = $jResp->BoolOf('data[i].$in_merge');
$Billing_State = $jResp->stringOf('data[i].Billing_State');
$Fax = $jResp->stringOf('data[i].Fax');
$Sapproval_state = $jResp->stringOf('data[i].$approval_state');
$j = 0;
$count_j = $jResp->SizeOfArray('data[i].Territories');
while ($j < $count_j) {
$jResp->put_J($j);
$Sassigned = $jResp->stringOf('data[i].Territories[j].$assigned');
$Sassigned_time = $jResp->stringOf('data[i].Territories[j].$assigned_time');
$id = $jResp->stringOf('data[i].Territories[j].id');
$Sassigned_by = $jResp->stringOf('data[i].Territories[j].$assigned_by');
$Name = $jResp->stringOf('data[i].Territories[j].Name');
$j = $j + 1;
}
$j = 0;
$count_j = $jResp->SizeOfArray('data[i].Tag');
while ($j < $count_j) {
$jResp->put_J($j);
$j = $j + 1;
}
$i = $i + 1;
}
?>
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
https://domain.com/crm/v2.1/Accounts
Postman Collection Item JSON
{
"name": "Accounts",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{access-token}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/Accounts",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"Accounts"
]
},
"description": "To get the list of available records in the Accounts module."
},
"response": [
{
"name": "P8: territory_id",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/Accounts?territory_id=738964000001977355",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"Accounts"
],
"query": [
{
"key": "territory_id",
"value": "738964000001977355"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Wed, 05 May 2021 06:44:50 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": "X-ACCESSTOKEN-RESET",
"value": "2021-05-05T07:39:40+00:00"
},
{
"key": "clientVersion",
"value": "4009533"
},
{
"key": "clientsubVersion",
"value": "cfa914635a0a376a1322139140e8bf37"
},
{
"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=15768000"
}
],
"cookie": [
],
"body": "{\n \"data\": [\n {\n \"Owner\": {\n \"name\": \"patricia patricia\",\n \"id\": \"738964000000291009\",\n \"email\": \"patricia.ss@zylker.com\"\n },\n \"$currency_symbol\": \"Af\",\n \"Account_Type\": null,\n \"SIC_Code\": null,\n \"$sharing_permission\": \"full_access\",\n \"Last_Activity_Time\": \"2021-04-21T08:53:58+00:00\",\n \"Industry\": null,\n \"Account_Site\": null,\n \"$state\": \"save\",\n \"$process_flow\": false,\n \"Exchange_Rate\": 1,\n \"Billing_Country\": null,\n \"Currency\": \"AFN\",\n \"id\": \"738964000002058030\",\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-04-21T08:53:58+00:00\",\n \"$editable\": true,\n \"Billing_Code\": \"1234\",\n \"Shipping_City\": null,\n \"Shipping_Country\": null,\n \"Shipping_Code\": null,\n \"Billing_City\": null,\n \"Created_By\": {\n \"name\": \"patricia patricia\",\n \"id\": \"738964000000291009\",\n \"email\": \"patricia.ss@zylker.com\"\n },\n \"Annual_Revenue\": 1,\n \"Shipping_Street\": null,\n \"territory_updated_time\": 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\": \"https://yaythisworked.com\",\n \"Employees\": null,\n \"Record_Image\": null,\n \"Modified_By\": {\n \"name\": \"patricia patricia\",\n \"id\": \"738964000000291009\",\n \"email\": \"patricia.ss@zylker.com\"\n },\n \"$review\": null,\n \"Phone\": null,\n \"Account_Name\": \"Zylker\",\n \"Account_Number\": \"0\",\n \"Ticker_Symbol\": null,\n \"Modified_Time\": \"2021-04-21T08:53:58+00:00\",\n \"Territories\": [\n {\n \"$assigned\": \"automatically\",\n \"$assigned_time\": \"2021-04-21T08:54:13+00:00\",\n \"id\": \"738964000001977355\",\n \"$assigned_by\": null,\n \"Name\": \"South Zone\"\n }\n ],\n \"$orchestration\": false,\n \"Parent_Account\": null,\n \"$in_merge\": false,\n \"Billing_State\": \"Colorado\",\n \"Tag\": [],\n \"Fax\": null,\n \"$approval_state\": \"approved\"\n }\n ],\n \"info\": {\n \"per_page\": 200,\n \"count\": 1,\n \"page\": 1,\n \"more_records\": false\n }\n}"
},
{
"name": "P9: include_child",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/Accounts?territory_id=738964000001977355&include_child=true",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"Accounts"
],
"query": [
{
"key": "territory_id",
"value": "738964000001977355"
},
{
"key": "include_child",
"value": "true"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Wed, 05 May 2021 06:45:34 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": "X-ACCESSTOKEN-RESET",
"value": "2021-05-05T07:39:40+00:00"
},
{
"key": "clientVersion",
"value": "4009533"
},
{
"key": "clientsubVersion",
"value": "cfa914635a0a376a1322139140e8bf37"
},
{
"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=15768000"
}
],
"cookie": [
],
"body": "{\n \"data\": [\n {\n \"Owner\": {\n \"name\": \"patricia patricia\",\n \"id\": \"738964000000291009\",\n \"email\": \"patricia.ss@zylker.com\"\n },\n \"$currency_symbol\": \"Af\",\n \"Account_Type\": null,\n \"SIC_Code\": null,\n \"$sharing_permission\": \"full_access\",\n \"Last_Activity_Time\": \"2021-04-21T08:53:58+00:00\",\n \"Industry\": null,\n \"Account_Site\": null,\n \"$state\": \"save\",\n \"$process_flow\": false,\n \"Exchange_Rate\": 1,\n \"Billing_Country\": null,\n \"Currency\": \"AFN\",\n \"id\": \"738964000002058030\",\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-04-21T08:53:58+00:00\",\n \"$editable\": true,\n \"Billing_Code\": \"1234\",\n \"Shipping_City\": null,\n \"Shipping_Country\": null,\n \"Shipping_Code\": null,\n \"Billing_City\": null,\n \"Created_By\": {\n \"name\": \"patricia patricia\",\n \"id\": \"738964000000291009\",\n \"email\": \"patricia.ss@zylker.com\"\n },\n \"Annual_Revenue\": 1,\n \"Shipping_Street\": null,\n \"territory_updated_time\": 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\": \"https://yaythisworked.com\",\n \"Employees\": null,\n \"Record_Image\": null,\n \"Modified_By\": {\n \"name\": \"patricia patricia\",\n \"id\": \"738964000000291009\",\n \"email\": \"patricia.ss@zylker.com\"\n },\n \"$review\": null,\n \"Phone\": null,\n \"Account_Name\": \"Zylker\",\n \"Account_Number\": \"0\",\n \"Ticker_Symbol\": null,\n \"Modified_Time\": \"2021-04-21T08:53:58+00:00\",\n \"Territories\": [\n {\n \"$assigned\": \"automatically\",\n \"$assigned_time\": \"2021-04-21T08:54:13+00:00\",\n \"id\": \"738964000001977355\",\n \"$assigned_by\": null,\n \"Name\": \"South Zone\"\n }\n ],\n \"$orchestration\": false,\n \"Parent_Account\": null,\n \"$in_merge\": false,\n \"Billing_State\": \"Colorado\",\n \"Tag\": [],\n \"Fax\": null,\n \"$approval_state\": \"approved\"\n }\n ],\n \"info\": {\n \"per_page\": 200,\n \"count\": 1,\n \"page\": 1,\n \"more_records\": false\n }\n}"
}
]
}
