Chilkat Online Tools

Go / Zoho CRM REST APIs / Organization Details

Back to Collection Items

    // This example assumes the Chilkat API to have been previously unlocked.
    // See Global_Ref.html">Global Unlock Sample for sample code.

    http := chilkat.NewHttp()
    var success bool

    http.SetRequestHeader("Authorization","{{authorization-token}}")

    sbResponseBody := chilkat.NewStringBuilder()
    success = http.QuickGetSb("https://domain.com/crm/v2/org",sbResponseBody)
    if success == false {
        fmt.Println(http.LastErrorText())
        http.DisposeHttp()
        sbResponseBody.DisposeStringBuilder()
        return
    }

    jResp := chilkat.NewJsonObject()
    jResp.LoadSb(sbResponseBody)
    jResp.SetEmitCompact(false)

    fmt.Println("Response Body:")
    fmt.Println(*jResp.Emit())

    respStatusCode := http.LastStatus()
    fmt.Println("Response Status Code = ", respStatusCode)
    if respStatusCode >= 400 {
        fmt.Println("Response Header:")
        fmt.Println(http.LastHeader())
        fmt.Println("Failed.")
        http.DisposeHttp()
        sbResponseBody.DisposeStringBuilder()
        jResp.DisposeJsonObject()
        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

    var country *string = new(string)
photo_    var id *string = new(string)
    var city *string = new(string)
    var description *string = new(string)
    var mc_status bool
    var gapps_enabled bool
    var domain_name *string = new(string)
    var translation_enabled bool
    var street *string = new(string)
    var alias *string = new(string)
    var v_currency *string = new(string)
    var id *string = new(string)
    var state *string = new(string)
    var fax *string = new(string)
    var employee_count *string = new(string)
    var zip *string = new(string)
    var website *string = new(string)
    var currency_symbol *string = new(string)
    var mobile *string = new(string)
    var currency_locale *string = new(string)
primary_zu    var id *string = new(string)
zia_portal_    var id *string = new(string)
    var time_zone *string = new(string)
zg    var id *string = new(string)
    var country_code *string = new(string)
    var Paid_expiry *string = new(string)
    var Users_license_purchased int
    var Trial_type *string = new(string)
    var Trial_expiry *string = new(string)
    var Paid bool
    var Paid_type *string = new(string)
    var phone *string = new(string)
    var company_name *string = new(string)
    var privacy_settings bool
    var primary_email *string = new(string)
    var iso_code *string = new(string)

    i := 0
    count_i := jResp.SizeOfArray("org")
    for i < count_i {
        jResp.SetI(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")
        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
    }


    http.DisposeHttp()
    sbResponseBody.DisposeStringBuilder()
    jResp.DisposeJsonObject()

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}"
    }
  ]
}