TCL / Support API / List Custom Roles
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
CkHttp_put_BasicAuth $http 1
CkHttp_put_Login $http "login"
CkHttp_put_Password $http "password"
CkHttp_SetRequestHeader $http "Accept" "application/json"
set sbResponseBody [new_CkStringBuilder]
set success [CkHttp_QuickGetSb $http "https://example.zendesk.com/api/v2/custom_roles" $sbResponseBody]
if {$success == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
exit
}
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttp_lastHeader $http]
puts "Failed."
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "custom_roles": [
# {
# "name": "<string>",
# "role_type": "<integer>",
# "configuration": {
# "assign_tickets_to_any_group": "<boolean>",
# "chat_access": "<boolean>",
# "end_user_list_access": "<string>",
# "end_user_profile_access": "<string>",
# "explore_access": "<string>",
# "forum_access": "<string>",
# "forum_access_restricted_content": "<boolean>",
# "group_access": "<boolean>",
# "light_agent": "<boolean>",
# "macro_access": "<string>",
# "manage_business_rules": "<boolean>",
# "manage_contextual_workspaces": "<boolean>",
# "manage_dynamic_content": "<boolean>",
# "manage_extensions_and_channels": "<boolean>",
# "manage_facebook": "<boolean>",
# "manage_organization_fields": "<boolean>",
# "manage_ticket_fields": "<boolean>",
# "manage_ticket_forms": "<boolean>",
# "manage_user_fields": "<boolean>",
# "moderate_forums": "<boolean>",
# "organization_editing": "<boolean>",
# "organization_notes_editing": "<boolean>",
# "report_access": "<string>",
# "side_conversation_create": "<boolean>",
# "ticket_access": "<string>",
# "ticket_comment_access": "<string>",
# "ticket_deletion": "<boolean>",
# "ticket_editing": "<boolean>",
# "ticket_merge": "<boolean>",
# "ticket_tag_editing": "<boolean>",
# "twitter_search_access": "<boolean>",
# "user_view_access": "<string>",
# "view_access": "<string>",
# "view_deleted_tickets": "<boolean>",
# "voice_access": "<boolean>",
# "voice_dashboard_access": "<boolean>"
# },
# "created_at": "<dateTime>",
# "description": "<string>",
# "id": "<integer>",
# "team_member_count": "<integer>",
# "updated_at": "<dateTime>"
# },
# {
# "name": "<string>",
# "role_type": "<integer>",
# "configuration": {
# "assign_tickets_to_any_group": "<boolean>",
# "chat_access": "<boolean>",
# "end_user_list_access": "<string>",
# "end_user_profile_access": "<string>",
# "explore_access": "<string>",
# "forum_access": "<string>",
# "forum_access_restricted_content": "<boolean>",
# "group_access": "<boolean>",
# "light_agent": "<boolean>",
# "macro_access": "<string>",
# "manage_business_rules": "<boolean>",
# "manage_contextual_workspaces": "<boolean>",
# "manage_dynamic_content": "<boolean>",
# "manage_extensions_and_channels": "<boolean>",
# "manage_facebook": "<boolean>",
# "manage_organization_fields": "<boolean>",
# "manage_ticket_fields": "<boolean>",
# "manage_ticket_forms": "<boolean>",
# "manage_user_fields": "<boolean>",
# "moderate_forums": "<boolean>",
# "organization_editing": "<boolean>",
# "organization_notes_editing": "<boolean>",
# "report_access": "<string>",
# "side_conversation_create": "<boolean>",
# "ticket_access": "<string>",
# "ticket_comment_access": "<string>",
# "ticket_deletion": "<boolean>",
# "ticket_editing": "<boolean>",
# "ticket_merge": "<boolean>",
# "ticket_tag_editing": "<boolean>",
# "twitter_search_access": "<boolean>",
# "user_view_access": "<string>",
# "view_access": "<string>",
# "view_deleted_tickets": "<boolean>",
# "voice_access": "<boolean>",
# "voice_dashboard_access": "<boolean>"
# },
# "created_at": "<dateTime>",
# "description": "<string>",
# "id": "<integer>",
# "team_member_count": "<integer>",
# "updated_at": "<dateTime>"
# }
# ]
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "custom_roles"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set name [CkJsonObject_stringOf $jResp "custom_roles[i].name"]
set role_type [CkJsonObject_stringOf $jResp "custom_roles[i].role_type"]
set Assign_tickets_to_any_group [CkJsonObject_stringOf $jResp "custom_roles[i].configuration.assign_tickets_to_any_group"]
set Chat_access [CkJsonObject_stringOf $jResp "custom_roles[i].configuration.chat_access"]
set End_user_list_access [CkJsonObject_stringOf $jResp "custom_roles[i].configuration.end_user_list_access"]
set End_user_profile_access [CkJsonObject_stringOf $jResp "custom_roles[i].configuration.end_user_profile_access"]
set Explore_access [CkJsonObject_stringOf $jResp "custom_roles[i].configuration.explore_access"]
set Forum_access [CkJsonObject_stringOf $jResp "custom_roles[i].configuration.forum_access"]
set Forum_access_restricted_content [CkJsonObject_stringOf $jResp "custom_roles[i].configuration.forum_access_restricted_content"]
set Group_access [CkJsonObject_stringOf $jResp "custom_roles[i].configuration.group_access"]
set Light_agent [CkJsonObject_stringOf $jResp "custom_roles[i].configuration.light_agent"]
set Macro_access [CkJsonObject_stringOf $jResp "custom_roles[i].configuration.macro_access"]
set Manage_business_rules [CkJsonObject_stringOf $jResp "custom_roles[i].configuration.manage_business_rules"]
set Manage_contextual_workspaces [CkJsonObject_stringOf $jResp "custom_roles[i].configuration.manage_contextual_workspaces"]
set Manage_dynamic_content [CkJsonObject_stringOf $jResp "custom_roles[i].configuration.manage_dynamic_content"]
set Manage_extensions_and_channels [CkJsonObject_stringOf $jResp "custom_roles[i].configuration.manage_extensions_and_channels"]
set Manage_facebook [CkJsonObject_stringOf $jResp "custom_roles[i].configuration.manage_facebook"]
set Manage_organization_fields [CkJsonObject_stringOf $jResp "custom_roles[i].configuration.manage_organization_fields"]
set Manage_ticket_fields [CkJsonObject_stringOf $jResp "custom_roles[i].configuration.manage_ticket_fields"]
set Manage_ticket_forms [CkJsonObject_stringOf $jResp "custom_roles[i].configuration.manage_ticket_forms"]
set Manage_user_fields [CkJsonObject_stringOf $jResp "custom_roles[i].configuration.manage_user_fields"]
set Moderate_forums [CkJsonObject_stringOf $jResp "custom_roles[i].configuration.moderate_forums"]
set Organization_editing [CkJsonObject_stringOf $jResp "custom_roles[i].configuration.organization_editing"]
set Organization_notes_editing [CkJsonObject_stringOf $jResp "custom_roles[i].configuration.organization_notes_editing"]
set Report_access [CkJsonObject_stringOf $jResp "custom_roles[i].configuration.report_access"]
set Side_conversation_create [CkJsonObject_stringOf $jResp "custom_roles[i].configuration.side_conversation_create"]
set Ticket_access [CkJsonObject_stringOf $jResp "custom_roles[i].configuration.ticket_access"]
set Ticket_comment_access [CkJsonObject_stringOf $jResp "custom_roles[i].configuration.ticket_comment_access"]
set Ticket_deletion [CkJsonObject_stringOf $jResp "custom_roles[i].configuration.ticket_deletion"]
set Ticket_editing [CkJsonObject_stringOf $jResp "custom_roles[i].configuration.ticket_editing"]
set Ticket_merge [CkJsonObject_stringOf $jResp "custom_roles[i].configuration.ticket_merge"]
set Ticket_tag_editing [CkJsonObject_stringOf $jResp "custom_roles[i].configuration.ticket_tag_editing"]
set Twitter_search_access [CkJsonObject_stringOf $jResp "custom_roles[i].configuration.twitter_search_access"]
set User_view_access [CkJsonObject_stringOf $jResp "custom_roles[i].configuration.user_view_access"]
set View_access [CkJsonObject_stringOf $jResp "custom_roles[i].configuration.view_access"]
set View_deleted_tickets [CkJsonObject_stringOf $jResp "custom_roles[i].configuration.view_deleted_tickets"]
set Voice_access [CkJsonObject_stringOf $jResp "custom_roles[i].configuration.voice_access"]
set Voice_dashboard_access [CkJsonObject_stringOf $jResp "custom_roles[i].configuration.voice_dashboard_access"]
set created_at [CkJsonObject_stringOf $jResp "custom_roles[i].created_at"]
set description [CkJsonObject_stringOf $jResp "custom_roles[i].description"]
set id [CkJsonObject_stringOf $jResp "custom_roles[i].id"]
set team_member_count [CkJsonObject_stringOf $jResp "custom_roles[i].team_member_count"]
set updated_at [CkJsonObject_stringOf $jResp "custom_roles[i].updated_at"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Curl Command
curl -u login:password -X GET
-H "Accept: application/json"
https://example.zendesk.com/api/v2/custom_roles
Postman Collection Item JSON
{
"name": "List Custom Roles",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/custom_roles",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"custom_roles"
]
},
"description": "#### Availability\n\n* Accounts on the Enterprise plan or above\n\n#### Allowed For\n\n* Agents\n"
},
"response": [
{
"name": "Success response",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/custom_roles",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"custom_roles"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"custom_roles\": [\n {\n \"name\": \"<string>\",\n \"role_type\": \"<integer>\",\n \"configuration\": {\n \"assign_tickets_to_any_group\": \"<boolean>\",\n \"chat_access\": \"<boolean>\",\n \"end_user_list_access\": \"<string>\",\n \"end_user_profile_access\": \"<string>\",\n \"explore_access\": \"<string>\",\n \"forum_access\": \"<string>\",\n \"forum_access_restricted_content\": \"<boolean>\",\n \"group_access\": \"<boolean>\",\n \"light_agent\": \"<boolean>\",\n \"macro_access\": \"<string>\",\n \"manage_business_rules\": \"<boolean>\",\n \"manage_contextual_workspaces\": \"<boolean>\",\n \"manage_dynamic_content\": \"<boolean>\",\n \"manage_extensions_and_channels\": \"<boolean>\",\n \"manage_facebook\": \"<boolean>\",\n \"manage_organization_fields\": \"<boolean>\",\n \"manage_ticket_fields\": \"<boolean>\",\n \"manage_ticket_forms\": \"<boolean>\",\n \"manage_user_fields\": \"<boolean>\",\n \"moderate_forums\": \"<boolean>\",\n \"organization_editing\": \"<boolean>\",\n \"organization_notes_editing\": \"<boolean>\",\n \"report_access\": \"<string>\",\n \"side_conversation_create\": \"<boolean>\",\n \"ticket_access\": \"<string>\",\n \"ticket_comment_access\": \"<string>\",\n \"ticket_deletion\": \"<boolean>\",\n \"ticket_editing\": \"<boolean>\",\n \"ticket_merge\": \"<boolean>\",\n \"ticket_tag_editing\": \"<boolean>\",\n \"twitter_search_access\": \"<boolean>\",\n \"user_view_access\": \"<string>\",\n \"view_access\": \"<string>\",\n \"view_deleted_tickets\": \"<boolean>\",\n \"voice_access\": \"<boolean>\",\n \"voice_dashboard_access\": \"<boolean>\"\n },\n \"created_at\": \"<dateTime>\",\n \"description\": \"<string>\",\n \"id\": \"<integer>\",\n \"team_member_count\": \"<integer>\",\n \"updated_at\": \"<dateTime>\"\n },\n {\n \"name\": \"<string>\",\n \"role_type\": \"<integer>\",\n \"configuration\": {\n \"assign_tickets_to_any_group\": \"<boolean>\",\n \"chat_access\": \"<boolean>\",\n \"end_user_list_access\": \"<string>\",\n \"end_user_profile_access\": \"<string>\",\n \"explore_access\": \"<string>\",\n \"forum_access\": \"<string>\",\n \"forum_access_restricted_content\": \"<boolean>\",\n \"group_access\": \"<boolean>\",\n \"light_agent\": \"<boolean>\",\n \"macro_access\": \"<string>\",\n \"manage_business_rules\": \"<boolean>\",\n \"manage_contextual_workspaces\": \"<boolean>\",\n \"manage_dynamic_content\": \"<boolean>\",\n \"manage_extensions_and_channels\": \"<boolean>\",\n \"manage_facebook\": \"<boolean>\",\n \"manage_organization_fields\": \"<boolean>\",\n \"manage_ticket_fields\": \"<boolean>\",\n \"manage_ticket_forms\": \"<boolean>\",\n \"manage_user_fields\": \"<boolean>\",\n \"moderate_forums\": \"<boolean>\",\n \"organization_editing\": \"<boolean>\",\n \"organization_notes_editing\": \"<boolean>\",\n \"report_access\": \"<string>\",\n \"side_conversation_create\": \"<boolean>\",\n \"ticket_access\": \"<string>\",\n \"ticket_comment_access\": \"<string>\",\n \"ticket_deletion\": \"<boolean>\",\n \"ticket_editing\": \"<boolean>\",\n \"ticket_merge\": \"<boolean>\",\n \"ticket_tag_editing\": \"<boolean>\",\n \"twitter_search_access\": \"<boolean>\",\n \"user_view_access\": \"<string>\",\n \"view_access\": \"<string>\",\n \"view_deleted_tickets\": \"<boolean>\",\n \"voice_access\": \"<boolean>\",\n \"voice_dashboard_access\": \"<boolean>\"\n },\n \"created_at\": \"<dateTime>\",\n \"description\": \"<string>\",\n \"id\": \"<integer>\",\n \"team_member_count\": \"<integer>\",\n \"updated_at\": \"<dateTime>\"\n }\n ]\n}"
}
]
}
