Objective-C / Zoho CRM REST APIs / Organization Details
Back to Collection Items
#import <CkoHttp.h>
#import <CkoStringBuilder.h>
#import <CkoJsonObject.h>
#import <NSString.h>
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;
[http SetRequestHeader: @"Authorization" value: @"{{authorization-token}}"];
CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
success = [http QuickGetSb: @"https://domain.com/crm/v2/org" sbContent: sbResponseBody];
if (success == NO) {
NSLog(@"%@",http.LastErrorText);
return;
}
CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;
NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);
int respStatusCode = [http.LastStatus intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
NSLog(@"%@",@"Response Header:");
NSLog(@"%@",http.LastHeader);
NSLog(@"%@",@"Failed.");
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "org": [
// {
// "country": null,
// "photo_id": null,
// "city": null,
// "description": null,
// "mc_status": true,
// "gapps_enabled": false,
// "domain_name": "org60036018",
// "translation_enabled": true,
// "street": null,
// "alias": null,
// "currency": "Indian Rupee",
// "id": "738964000000300043",
// "state": null,
// "fax": null,
// "employee_count": null,
// "zip": null,
// "website": null,
// "currency_symbol": "₹",
// "mobile": null,
// "currency_locale": "en_IN",
// "primary_zuid": "60034346",
// "zia_portal_id": null,
// "time_zone": "Asia/Kolkata",
// "zgid": "60036018",
// "country_code": "IN",
// "license_details": {
// "paid_expiry": "2021-10-20T00:00:00+00:00",
// "users_license_purchased": 25,
// "trial_type": null,
// "trial_expiry": null,
// "paid": true,
// "paid_type": "enterprise"
// },
// "phone": "312",
// "company_name": "Zylker",
// "privacy_settings": true,
// "primary_email": "patricia@zylker.com",
// "iso_code": "INR"
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
NSString *country = 0;
NSString *photo_id = 0;
NSString *city = 0;
NSString *description = 0;
BOOL mc_status;
BOOL gapps_enabled;
NSString *domain_name = 0;
BOOL translation_enabled;
NSString *street = 0;
NSString *alias = 0;
NSString *v_currency = 0;
NSString *id = 0;
NSString *state = 0;
NSString *fax = 0;
NSString *employee_count = 0;
NSString *zip = 0;
NSString *website = 0;
NSString *currency_symbol = 0;
NSString *mobile = 0;
NSString *currency_locale = 0;
NSString *primary_zuid = 0;
NSString *zia_portal_id = 0;
NSString *time_zone = 0;
NSString *zgid = 0;
NSString *country_code = 0;
NSString *Paid_expiry = 0;
int Users_license_purchased;
NSString *Trial_type = 0;
NSString *Trial_expiry = 0;
BOOL Paid;
NSString *Paid_type = 0;
NSString *phone = 0;
NSString *company_name = 0;
BOOL privacy_settings;
NSString *primary_email = 0;
NSString *iso_code = 0;
int i = 0;
int count_i = [[jResp SizeOfArray: @"org"] intValue];
while (i < count_i) {
jResp.I = [NSNumber numberWithInt: i];
country = [jResp StringOf: @"org[i].country"];
photo_id = [jResp StringOf: @"org[i].photo_id"];
city = [jResp StringOf: @"org[i].city"];
description = [jResp StringOf: @"org[i].description"];
mc_status = [jResp BoolOf: @"org[i].mc_status"];
gapps_enabled = [jResp BoolOf: @"org[i].gapps_enabled"];
domain_name = [jResp StringOf: @"org[i].domain_name"];
translation_enabled = [jResp BoolOf: @"org[i].translation_enabled"];
street = [jResp StringOf: @"org[i].street"];
alias = [jResp StringOf: @"org[i].alias"];
v_currency = [jResp StringOf: @"org[i].currency"];
id = [jResp StringOf: @"org[i].id"];
state = [jResp StringOf: @"org[i].state"];
fax = [jResp StringOf: @"org[i].fax"];
employee_count = [jResp StringOf: @"org[i].employee_count"];
zip = [jResp StringOf: @"org[i].zip"];
website = [jResp StringOf: @"org[i].website"];
currency_symbol = [jResp StringOf: @"org[i].currency_symbol"];
mobile = [jResp StringOf: @"org[i].mobile"];
currency_locale = [jResp StringOf: @"org[i].currency_locale"];
primary_zuid = [jResp StringOf: @"org[i].primary_zuid"];
zia_portal_id = [jResp StringOf: @"org[i].zia_portal_id"];
time_zone = [jResp StringOf: @"org[i].time_zone"];
zgid = [jResp StringOf: @"org[i].zgid"];
country_code = [jResp StringOf: @"org[i].country_code"];
Paid_expiry = [jResp StringOf: @"org[i].license_details.paid_expiry"];
Users_license_purchased = [[jResp IntOf: @"org[i].license_details.users_license_purchased"] intValue];
Trial_type = [jResp StringOf: @"org[i].license_details.trial_type"];
Trial_expiry = [jResp StringOf: @"org[i].license_details.trial_expiry"];
Paid = [jResp BoolOf: @"org[i].license_details.paid"];
Paid_type = [jResp StringOf: @"org[i].license_details.paid_type"];
phone = [jResp StringOf: @"org[i].phone"];
company_name = [jResp StringOf: @"org[i].company_name"];
privacy_settings = [jResp BoolOf: @"org[i].privacy_settings"];
primary_email = [jResp StringOf: @"org[i].primary_email"];
iso_code = [jResp StringOf: @"org[i].iso_code"];
i = i + 1;
}
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
-H "Authorization: {{authorization-token}}"
https://domain.com/crm/v2/org
Postman Collection Item JSON
{
"name": "Organization Details",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{access-token}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
{
"key": "Authorization",
"value": "{{authorization-token}}"
}
],
"url": {
"raw": "{{api-domain}}/crm/v2/org",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"org"
]
},
"description": "To get the organization data."
},
"response": [
{
"name": "SUCCESS RESPONSE",
"originalRequest": {
"method": "GET",
"header": [
{
"key": "Authorization",
"value": "{{authorization-token}}"
}
],
"url": {
"raw": "{{api-domain}}/crm/v2/org",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"org"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 11 May 2021 10:49:49 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "796"
},
{
"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-store, no-cache, must-revalidate, private"
},
{
"key": "Expires",
"value": "Thu, 01 Jan 1970 00:00:00 GMT"
},
{
"key": "X-Frame-Options",
"value": "SAMEORIGIN"
},
{
"key": "X-ACCESSTOKEN-RESET",
"value": "2021-05-11T11:08:26+00:00"
},
{
"key": "clientVersion",
"value": "4023320"
},
{
"key": "clientsubVersion",
"value": "4d8b6ee4f7d1d284c930a4e807480c5c"
},
{
"key": "Content-Disposition",
"value": "attachment; filename=response.json"
},
{
"key": "Content-Language",
"value": "en-US"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=15768000"
}
],
"cookie": [
],
"body": "{\n \"org\": [\n {\n \"country\": null,\n \"photo_id\": null,\n \"city\": null,\n \"description\": null,\n \"mc_status\": true,\n \"gapps_enabled\": false,\n \"domain_name\": \"org60036018\",\n \"translation_enabled\": true,\n \"street\": null,\n \"alias\": null,\n \"currency\": \"Indian Rupee\",\n \"id\": \"738964000000300043\",\n \"state\": null,\n \"fax\": null,\n \"employee_count\": null,\n \"zip\": null,\n \"website\": null,\n \"currency_symbol\": \"₹\",\n \"mobile\": null,\n \"currency_locale\": \"en_IN\",\n \"primary_zuid\": \"60034346\",\n \"zia_portal_id\": null,\n \"time_zone\": \"Asia/Kolkata\",\n \"zgid\": \"60036018\",\n \"country_code\": \"IN\",\n \"license_details\": {\n \"paid_expiry\": \"2021-10-20T00:00:00+00:00\",\n \"users_license_purchased\": 25,\n \"trial_type\": null,\n \"trial_expiry\": null,\n \"paid\": true,\n \"paid_type\": \"enterprise\"\n },\n \"phone\": \"312\",\n \"company_name\": \"Zylker\",\n \"privacy_settings\": true,\n \"primary_email\": \"patricia@zylker.com\",\n \"iso_code\": \"INR\"\n }\n ]\n}"
},
{
"name": "INVALID_REQUEST_METHOD",
"originalRequest": {
"method": "COPY",
"header": [
{
"key": "Authorization",
"value": "{{authorization-token}}"
}
],
"url": {
"raw": "{{api-domain}}/crm/v2/org",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"org"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 11 May 2021 10:50:28 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": [
{
"key": "Authorization",
"value": "{{authorization-token}}"
}
],
"url": {
"raw": "{{api-domain}}/crm/v2/org",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"org"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Tue, 11 May 2021 10:52: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": [
{
"key": "Authorization",
"value": "{{authorization-token}}"
}
],
"url": {
"raw": "{{api-domain}}/crm/v2/org",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2",
"org"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Thu, 13 May 2021 06:31:49 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}"
}
]
}
