Back to Collection Items
void ChilkatSample(void)
{
http.put_AuthToken(L"<access_token>"); success = http.QuickGetSb(L"https://domain.com/crm/v2.1/settings/modules/Leads",sbResponseBody); jResp.LoadSb(sbResponseBody); jResp.put_EmitCompact(false); jResp.put_I(i); global_search_supported = jResp.BoolOf(L"modules[i].global_search_supported"); kanban_view = jResp.BoolOf(L"modules[i].kanban_view"); deletable = jResp.BoolOf(L"modules[i].deletable"); description = jResp.stringOf(L"modules[i].description"); creatable = jResp.BoolOf(L"modules[i].creatable"); filter_status = jResp.BoolOf(L"modules[i].filter_status"); inventory_template_supported = jResp.BoolOf(L"modules[i].inventory_template_supported"); modified_time = jResp.stringOf(L"modules[i].modified_time"); plural_label = jResp.stringOf(L"modules[i].plural_label"); presence_sub_menu = jResp.BoolOf(L"modules[i].presence_sub_menu"); triggers_supported = jResp.BoolOf(L"modules[i].triggers_supported"); id = jResp.stringOf(L"modules[i].id"); isBlueprintSupported = jResp.BoolOf(L"modules[i].isBlueprintSupported"); Sort_by = jResp.stringOf(L"modules[i].related_list_properties.sort_by"); Sort_order = jResp.stringOf(L"modules[i].related_list_properties.sort_order"); per_page = jResp.IntOf(L"modules[i].per_page"); visible = jResp.BoolOf(L"modules[i].visible"); visibility = jResp.IntOf(L"modules[i].visibility"); convertable = jResp.BoolOf(L"modules[i].convertable"); editable = jResp.BoolOf(L"modules[i].editable"); emailTemplate_support = jResp.BoolOf(L"modules[i].emailTemplate_support"); filter_supported = jResp.BoolOf(L"modules[i].filter_supported"); display_field = jResp.stringOf(L"modules[i].display_field"); kanban_view_supported = jResp.BoolOf(L"modules[i].kanban_view_supported"); show_as_tab = jResp.BoolOf(L"modules[i].show_as_tab"); web_link = jResp.stringOf(L"modules[i].web_link"); sequence_number = jResp.IntOf(L"modules[i].sequence_number"); singular_label = jResp.stringOf(L"modules[i].singular_label"); viewable = jResp.BoolOf(L"modules[i].viewable"); api_supported = jResp.BoolOf(L"modules[i].api_supported"); api_name = jResp.stringOf(L"modules[i].api_name"); quick_create = jResp.BoolOf(L"modules[i].quick_create"); Name = jResp.stringOf(L"modules[i].modified_by.name"); Id = jResp.stringOf(L"modules[i].modified_by.id"); generated_type = jResp.stringOf(L"modules[i].generated_type"); feeds_required = jResp.BoolOf(L"modules[i].feeds_required"); scoring_supported = jResp.BoolOf(L"modules[i].scoring_supported"); webform_supported = jResp.BoolOf(L"modules[i].webform_supported"); module_name = jResp.stringOf(L"modules[i].module_name"); business_card_field_limit = jResp.IntOf(L"modules[i].business_card_field_limit"); Display_value = jResp.stringOf(L"modules[i].custom_view.display_value"); Access_type = jResp.stringOf(L"modules[i].custom_view.access_type"); Criteria = jResp.stringOf(L"modules[i].custom_view.criteria"); System_name = jResp.stringOf(L"modules[i].custom_view.system_name"); custom_viewSort_by = jResp.stringOf(L"modules[i].custom_view.sort_by"); Created_byName = jResp.stringOf(L"modules[i].custom_view.created_by.name"); Created_byId = jResp.stringOf(L"modules[i].custom_view.created_by.id"); Default = jResp.BoolOf(L"modules[i].custom_view.default"); Modified_time = jResp.stringOf(L"modules[i].custom_view.modified_time"); custom_viewName = jResp.stringOf(L"modules[i].custom_view.name"); System_defined = jResp.BoolOf(L"modules[i].custom_view.system_defined"); Modified_byName = jResp.stringOf(L"modules[i].custom_view.modified_by.name"); Modified_byId = jResp.stringOf(L"modules[i].custom_view.modified_by.id"); custom_viewId = jResp.stringOf(L"modules[i].custom_view.id"); Category = jResp.stringOf(L"modules[i].custom_view.category"); Last_accessed_time = jResp.stringOf(L"modules[i].custom_view.last_accessed_time"); custom_viewSort_order = jResp.stringOf(L"modules[i].custom_view.sort_order"); Favorite = jResp.stringOf(L"modules[i].custom_view.favorite"); j = 0; count_j = jResp.SizeOfArray(L"modules[i].related_list_properties.fields"); jResp.put_J(j); strVal = jResp.stringOf(L"modules[i].related_list_properties.fields[j]"); j = j + 1; j = 0; count_j = jResp.SizeOfArray(L"modules[i].$properties"); jResp.put_J(j); strVal = jResp.stringOf(L"modules[i].$properties[j]"); j = j + 1; j = 0; count_j = jResp.SizeOfArray(L"modules[i].profiles"); jResp.put_J(j); name = jResp.stringOf(L"modules[i].profiles[j].name"); id = jResp.stringOf(L"modules[i].profiles[j].id"); j = j + 1; j = 0; count_j = jResp.SizeOfArray(L"modules[i].$on_demand_properties"); jResp.put_J(j); strVal = jResp.stringOf(L"modules[i].$on_demand_properties[j]"); j = j + 1; j = 0; count_j = jResp.SizeOfArray(L"modules[i].search_layout_fields"); jResp.put_J(j); strVal = jResp.stringOf(L"modules[i].search_layout_fields[j]"); j = j + 1; j = 0; count_j = jResp.SizeOfArray(L"modules[i].arguments"); jResp.put_J(j); j = j + 1; j = 0; count_j = jResp.SizeOfArray(L"modules[i].custom_view.shared_to"); jResp.put_J(j); name = jResp.stringOf(L"modules[i].custom_view.shared_to[j].name"); id = jResp.stringOf(L"modules[i].custom_view.shared_to[j].id"); v_type = jResp.stringOf(L"modules[i].custom_view.shared_to[j].type"); subordinates = jResp.stringOf(L"modules[i].custom_view.shared_to[j].subordinates"); j = j + 1; j = 0; count_j = jResp.SizeOfArray(L"modules[i].custom_view.fields"); jResp.put_J(j); api_name = jResp.stringOf(L"modules[i].custom_view.fields[j].api_name"); id = jResp.stringOf(L"modules[i].custom_view.fields[j].id"); j = j + 1; i = i + 1;
}
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
https://domain.com/crm/v2.1/settings/modules/Leads
Postman Collection Item JSON
{
"name": "Leads",
"request": {
"auth": {
"type": "bearer",
"bearer": [
{
"key": "token",
"value": "{{access-token}}",
"type": "string"
}
]
},
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/modules/Leads",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"modules",
"Leads"
]
},
"description": "To get the metadata of the Leads Module."
},
"response": [
{
"name": "SUCCESS RESPONSE",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/modules/Leads",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"modules",
"Leads"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Wed, 05 May 2021 06:05:59 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-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 \"modules\": [\n {\n \"global_search_supported\": true,\n \"kanban_view\": false,\n \"deletable\": true,\n \"description\": null,\n \"creatable\": true,\n \"filter_status\": true,\n \"inventory_template_supported\": false,\n \"modified_time\": \"2021-04-04T08:54:55+05:30\",\n \"plural_label\": \"Leads\",\n \"presence_sub_menu\": true,\n \"triggers_supported\": true,\n \"id\": \"4150868000000002175\",\n \"isBlueprintSupported\": true,\n \"related_list_properties\": {\n \"sort_by\": null,\n \"fields\": [\n \"Full_Name\",\n \"Company\",\n \"Email\",\n \"Lead_Source\",\n \"Lead_Status\",\n \"Phone\"\n ],\n \"sort_order\": null\n },\n \"per_page\": 100,\n \"$properties\": [\n \"$converted\",\n \"$approved\",\n \"$approval_state\",\n \"$state\",\n \"$converted_detail\",\n \"$currency_symbol\",\n \"$review\",\n \"$review_process\",\n \"$approval\",\n \"$in_merge\",\n \"$followed\",\n \"$followers\",\n \"$process_flow\",\n \"$orchestration\",\n \"$stop_processing\",\n \"$data_source_details\",\n \"$has_more\"\n ],\n \"visible\": true,\n \"visibility\": 1,\n \"convertable\": true,\n \"editable\": true,\n \"emailTemplate_support\": true,\n \"profiles\": [\n {\n \"name\": \"Administrator\",\n \"id\": \"4150868000000026011\"\n },\n {\n \"name\": \"Standard\",\n \"id\": \"4150868000000026014\"\n },\n {\n \"name\": \"sample\",\n \"id\": \"4150868000001623001\"\n }\n ],\n \"filter_supported\": true,\n \"$on_demand_properties\": [\n \"$blocked_reason\"\n ],\n \"display_field\": \"Full_Name\",\n \"search_layout_fields\": [\n \"Owner\",\n \"Company\",\n \"Full_Name\",\n \"Email\",\n \"Phone\",\n \"Lead_Source\"\n ],\n \"kanban_view_supported\": true,\n \"show_as_tab\": true,\n \"web_link\": null,\n \"sequence_number\": 23,\n \"singular_label\": \"Lead\",\n \"viewable\": true,\n \"api_supported\": true,\n \"api_name\": \"Leads\",\n \"quick_create\": true,\n \"modified_by\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"4150868000000225013\"\n },\n \"generated_type\": \"default\",\n \"feeds_required\": true,\n \"scoring_supported\": true,\n \"webform_supported\": true,\n \"arguments\": [],\n \"module_name\": \"Leads\",\n \"business_card_field_limit\": 5,\n \"custom_view\": {\n \"display_value\": \"Sample View\",\n \"access_type\": \"shared\",\n \"criteria\": null,\n \"system_name\": null,\n \"sort_by\": null,\n \"created_by\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"4150868000000225013\"\n },\n \"shared_to\": [\n {\n \"name\": \"Group1\",\n \"id\": \"4150868000000231952\",\n \"type\": \"groups\",\n \"subordinates\": null\n },\n {\n \"name\": \"User 3\",\n \"id\": \"4150868000001199001\",\n \"type\": \"users\",\n \"subordinates\": null\n },\n {\n \"name\": \"User 2\",\n \"id\": \"4150868000001248015\",\n \"type\": \"users\",\n \"subordinates\": null\n }\n ],\n \"default\": true,\n \"modified_time\": \"2021-03-04T00:54:53+05:30\",\n \"name\": \"Sample View\",\n \"system_defined\": false,\n \"modified_by\": {\n \"name\": \"Patricia Boyle\",\n \"id\": \"4150868000000225013\"\n },\n \"id\": \"4150868000004520004\",\n \"fields\": [\n {\n \"api_name\": \"Full_Name\",\n \"id\": \"4150868000000002631\"\n },\n {\n \"api_name\": \"Company\",\n \"id\": \"4150868000000002591\"\n },\n {\n \"api_name\": \"Email\",\n \"id\": \"4150868000000002599\"\n },\n {\n \"api_name\": \"Phone\",\n \"id\": \"4150868000000002601\"\n },\n {\n \"api_name\": \"Lead_Source\",\n \"id\": \"4150868000000002609\"\n },\n {\n \"api_name\": \"Owner\",\n \"id\": \"4150868000000002589\"\n }\n ],\n \"category\": \"created_by_me\",\n \"last_accessed_time\": \"2021-05-04T17:11:45+05:30\",\n \"sort_order\": null,\n \"favorite\": null\n },\n \"parent_module\": {}\n }\n ]\n}"
},
{
"name": "INVALID_MODULE",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/modules/Lead",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"modules",
"Lead"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Wed, 05 May 2021 06:07:15 GMT"
},
{
"key": "Content-Type",
"value": "application/json;charset=utf-8"
},
{
"key": "Content-Length",
"value": "133"
},
{
"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": "clientVersion",
"value": "4002155"
},
{
"key": "clientsubVersion",
"value": "bfb2326744b42e5c869a705645ac0006"
},
{
"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_MODULE\",\n \"details\": {\n \"resource_path_index\": 2\n },\n \"message\": \"the module name given seems to be invalid\",\n \"status\": \"error\"\n}"
},
{
"name": "INVALID_URL_PATTERN",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/modulesLeads",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"modulesLeads"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Wed, 05 May 2021 06:07:28 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": "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": "AUTHENTICATION_FAILURE",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/modules/Leads",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"modules",
"Leads"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Wed, 05 May 2021 06:07:47 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": "INVALID_REQUEST_METHOD",
"originalRequest": {
"method": "POST",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/modules/Leads",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"modules",
"Leads"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Wed, 05 May 2021 06:08:06 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": "OAUTH_SCOPE_MISMATCH",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{api-domain}}/crm/v2.1/settings/modules/Leads",
"host": [
"{{api-domain}}"
],
"path": [
"crm",
"v2.1",
"settings",
"modules",
"Leads"
]
}
},
"status": "Unauthorized",
"code": 401,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Server",
"value": "ZGS"
},
{
"key": "Date",
"value": "Wed, 05 May 2021 07:30:26 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}"
}
]
}
