Chilkat Online Tools

Go / Zoho CRM REST APIs / Profiles

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.1/settings/profiles",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)

    // {
    //   "profiles": [
    //     {
    //       "display_label": "Administrator",
    //       "created_time": null,
    //       "modified_time": "2020-04-01T12:57:59+05:30",
    //       "custom": false,
    //       "name": "Administrator",
    //       "modified_by": {
    //         "name": "Patricia Boyle",
    //         "id": "4150868000000225013"
    //       },
    //       "description": "This profile will have all the permissions. Users with Administrator profile will be able to view and manage all the data within the organization account by default.",
    //       "id": "4150868000000026011",
    //       "created_by": null
    //     },
    //     {
    //       "display_label": "Standard",
    //       "created_time": null,
    //       "modified_time": "2020-09-15T16:46:38+05:30",
    //       "custom": false,
    //       "name": "Standard",
    //       "modified_by": {
    //         "name": "Patricia Boyle",
    //         "id": "4150868000000225013"
    //       },
    //       "description": "This profile will have all the permissions except administrative privileges.",
    //       "id": "4150868000000026014",
    //       "created_by": null
    //     },
    //     {
    //       "display_label": "p2",
    //       "created_time": "2020-02-25T10:35:36+05:30",
    //       "modified_time": "2021-03-02T10:52:13+05:30",
    //       "custom": true,
    //       "name": "p2",
    //       "modified_by": {
    //         "name": "Patricia Boyle",
    //         "id": "4150868000000225013"
    //       },
    //       "description": null,
    //       "id": "4150868000001416100",
    //       "created_by": {
    //         "name": "Patricia Boyle",
    //         "id": "4150868000000225013"
    //       }
    //     },
    //     {
    //       "display_label": "sample",
    //       "created_time": "2020-03-13T16:28:12+05:30",
    //       "modified_time": "2021-01-21T15:28:32+05:30",
    //       "custom": true,
    //       "name": "sample",
    //       "modified_by": {
    //         "name": "Patricia Boyle",
    //         "id": "4150868000000225013"
    //       },
    //       "description": "sd",
    //       "id": "4150868000001623001",
    //       "created_by": {
    //         "name": "Patricia Boyle",
    //         "id": "4150868000000225013"
    //       }
    //     }
    //   ]
    // }

    // Sample code for parsing the JSON response...
    // Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

    var display_label *string = new(string)
    var created_time *string = new(string)
    var modified_time *string = new(string)
    var custom bool
    var name *string = new(string)
    var Name *string = new(string)
    var Id *string = new(string)
    var description *string = new(string)
    var id *string = new(string)
    var created_by *string = new(string)
    var created_byName *string = new(string)
created_by    var Id *string = new(string)

    i := 0
    count_i := jResp.SizeOfArray("profiles")
    for i < count_i {
        jResp.SetI(i)
        display_label = jResp.StringOf("profiles[i].display_label")
        created_time = jResp.StringOf("profiles[i].created_time")
        modified_time = jResp.StringOf("profiles[i].modified_time")
        custom = jResp.BoolOf("profiles[i].custom")
        name = jResp.StringOf("profiles[i].name")
        Name = jResp.StringOf("profiles[i].modified_by.name")
        Id = jResp.StringOf("profiles[i].modified_by.id")
        description = jResp.StringOf("profiles[i].description")
        id = jResp.StringOf("profiles[i].id")
        created_by = jResp.StringOf("profiles[i].created_by")
        created_byName = jResp.StringOf("profiles[i].created_by.name")
        created_byId = jResp.StringOf("profiles[i].created_by.id")
        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.1/settings/profiles

Postman Collection Item JSON

{
  "name": "Profiles",
  "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.1/settings/profiles",
      "host": [
        "{{api-domain}}"
      ],
      "path": [
        "crm",
        "v2.1",
        "settings",
        "profiles"
      ]
    },
    "description": "To retrieve the data of profiles of your organization."
  },
  "response": [
    {
      "name": "SUCCESS RESPONSE",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Authorization",
            "value": "{{authorization-token}}"
          }
        ],
        "url": {
          "raw": "{{api-domain}}/crm/v2.1/settings/profiles",
          "host": [
            "{{api-domain}}"
          ],
          "path": [
            "crm",
            "v2.1",
            "settings",
            "profiles"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "ZGS"
        },
        {
          "key": "Date",
          "value": "Wed, 05 May 2021 06:03:12 GMT"
        },
        {
          "key": "Content-Type",
          "value": "application/json;charset=utf-8"
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked"
        },
        {
          "key": "Connection",
          "value": "keep-alive"
        },
        {
          "key": "Set-Cookie",
          "value": "1a99390653=a65db6687ba820b24201653a06c01d2e; Path=/"
        },
        {
          "key": "Set-Cookie",
          "value": "crmcsr=cf92359b-7285-4937-9444-4521cefc7fcb;path=/;SameSite=None;Secure;priority=high"
        },
        {
          "key": "Set-Cookie",
          "value": "_zcsr_tmp=cf92359b-7285-4937-9444-4521cefc7fcb;path=/;SameSite=Strict;Secure;priority=high"
        },
        {
          "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-05T12:33:08+05:30"
        },
        {
          "key": "clientVersion",
          "value": "4002155"
        },
        {
          "key": "clientsubVersion",
          "value": "bfb2326744b42e5c869a705645ac0006"
        },
        {
          "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    \"profiles\": [\n        {\n            \"display_label\": \"Administrator\",\n            \"created_time\": null,\n            \"modified_time\": \"2020-04-01T12:57:59+05:30\",\n            \"custom\": false,\n            \"name\": \"Administrator\",\n            \"modified_by\": {\n                \"name\": \"Patricia Boyle\",\n                \"id\": \"4150868000000225013\"\n            },\n            \"description\": \"This profile will have all the permissions. Users with Administrator profile will be able to view and manage all the data within the organization account by default.\",\n            \"id\": \"4150868000000026011\",\n            \"created_by\": null\n        },\n        {\n            \"display_label\": \"Standard\",\n            \"created_time\": null,\n            \"modified_time\": \"2020-09-15T16:46:38+05:30\",\n            \"custom\": false,\n            \"name\": \"Standard\",\n            \"modified_by\": {\n                \"name\": \"Patricia Boyle\",\n                \"id\": \"4150868000000225013\"\n            },\n            \"description\": \"This profile will have all the permissions except administrative privileges.\",\n            \"id\": \"4150868000000026014\",\n            \"created_by\": null\n        },\n        {\n            \"display_label\": \"p2\",\n            \"created_time\": \"2020-02-25T10:35:36+05:30\",\n            \"modified_time\": \"2021-03-02T10:52:13+05:30\",\n            \"custom\": true,\n            \"name\": \"p2\",\n            \"modified_by\": {\n                \"name\": \"Patricia Boyle\",\n                \"id\": \"4150868000000225013\"\n            },\n            \"description\": null,\n            \"id\": \"4150868000001416100\",\n            \"created_by\": {\n                \"name\": \"Patricia Boyle\",\n                \"id\": \"4150868000000225013\"\n            }\n        },\n        {\n            \"display_label\": \"sample\",\n            \"created_time\": \"2020-03-13T16:28:12+05:30\",\n            \"modified_time\": \"2021-01-21T15:28:32+05:30\",\n            \"custom\": true,\n            \"name\": \"sample\",\n            \"modified_by\": {\n                \"name\": \"Patricia Boyle\",\n                \"id\": \"4150868000000225013\"\n            },\n            \"description\": \"sd\",\n            \"id\": \"4150868000001623001\",\n            \"created_by\": {\n                \"name\": \"Patricia Boyle\",\n                \"id\": \"4150868000000225013\"\n            }\n        }\n    ]\n}"
    },
    {
      "name": "INVALID_URL_PATTERN",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "key": "Authorization",
            "value": "{{authorization-token}}"
          }
        ],
        "url": {
          "raw": "{{api-domain}}/crm/v2.1/settings/profile",
          "host": [
            "{{api-domain}}"
          ],
          "path": [
            "crm",
            "v2.1",
            "settings",
            "profile"
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "ZGS"
        },
        {
          "key": "Date",
          "value": "Wed, 05 May 2021 06:04:34 GMT"
        },
        {
          "key": "Content-Type",
          "value": "application/json;charset=utf-8"
        },
        {
          "key": "Content-Length",
          "value": "131"
        },
        {
          "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-05T12:33:08+05:30"
        },
        {
          "key": "Set-Cookie",
          "value": "JSESSIONID=5B35DB053EE732FC285F20F5D97D8B4A; Path=/; Secure"
        },
        {
          "key": "Content-Disposition",
          "value": "attachment; filename=response.json"
        },
        {
          "key": "X-Download-Options",
          "value": "noopen"
        },
        {
          "key": "Content-Language",
          "value": "en-US"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"code\": \"INVALID_URL_PATTERN\",\n    \"details\": {},\n    \"message\": \"Please check if the URL trying to access is a correct one\",\n    \"status\": \"error\"\n}"
    },
    {
      "name": "INVALID_REQUEST_METHOD",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "key": "Authorization",
            "value": "{{authorization-token}}"
          }
        ],
        "url": {
          "raw": "{{api-domain}}/crm/v2.1/settings/profile",
          "host": [
            "{{api-domain}}"
          ],
          "path": [
            "crm",
            "v2.1",
            "settings",
            "profile"
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "ZGS"
        },
        {
          "key": "Date",
          "value": "Wed, 05 May 2021 06:04:54 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.1/settings/profile",
          "host": [
            "{{api-domain}}"
          ],
          "path": [
            "crm",
            "v2.1",
            "settings",
            "profile"
          ]
        }
      },
      "status": "Unauthorized",
      "code": 401,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "ZGS"
        },
        {
          "key": "Date",
          "value": "Wed, 05 May 2021 06:05:14 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.1/settings/profiles",
          "host": [
            "{{api-domain}}"
          ],
          "path": [
            "crm",
            "v2.1",
            "settings",
            "profiles"
          ]
        }
      },
      "status": "Unauthorized",
      "code": 401,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Server",
          "value": "ZGS"
        },
        {
          "key": "Date",
          "value": "Wed, 05 May 2021 07:30:10 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}"
    }
  ]
}