List Custom Roles

GET {{baseUrl}}/api/v2/custom_roles

Availability

• Accounts on the Enterprise plan or above

Allowed For

• Agents

HEADERS

RESPONSES

status: OK

{"custom_roles":[{"configuration":{"assign_tickets_to_any_group":false,"chat_access":true,"end_user_list_access":"full","end_user_profile_access":"readonly","explore_access":"edit","forum_access":"readonly","forum_access_restricted_content":false,"group_access":true,"light_agent":false,"macro_access":"full","manage_business_rules":true,"manage_contextual_workspaces":false,"manage_dynamic_content":false,"manage_extensions_and_channels":true,"manage_facebook":false,"manage_organization_fields":false,"manage_ticket_fields":false,"manage_ticket_forms":false,"manage_user_fields":false,"moderate_forums":false,"organization_editing":false,"organization_notes_editing":false,"report_access":"none","side_conversation_create":true,"ticket_access":"within-groups","ticket_comment_access":"none","ticket_deletion":false,"ticket_editing":true,"ticket_merge":false,"ticket_tag_editing":true,"twitter_search_access":true,"user_view_access":"readonly","view_access":"full","view_deleted_tickets":false,"voice_access":true,"voice_dashboard_access":false},"created_at":"2012-03-12T16:32:22Z","description":"Advisors manage the workflow and configure the help desk. They create or manage automations, macros, triggers, views, and SLA targets. They also set up channels and extensions. Advisors don't solve tickets, they can only make private comments.","id":16,"name":"Advisor","role_type":0,"team_member_count":10,"updated_at":"2012-03-12T16:32:22Z"},{"configuration":{"assign_tickets_to_any_group":false,"chat_access":true,"end_user_list_access":"full","end_user_profile_access":"readonly","explore_access":"edit","forum_access":"readonly","forum_access_restricted_content":false,"group_access":true,"light_agent":false,"macro_access":"full","manage_business_rules":true,"manage_contextual_workspaces":false,"manage_dynamic_content":false,"manage_extensions_and_channels":true,"manage_facebook":false,"manage_organization_fields":false,"manage_ticket_fields":false,"manage_ticket_forms":false,"manage_user_fields":false,"moderate_forums":false,"organization_editing":false,"organization_notes_editing":false,"report_access":"none","side_conversation_create":true,"ticket_access":"within-groups","ticket_comment_access":"none","ticket_deletion":false,"ticket_editing":true,"ticket_merge":false,"ticket_tag_editing":true,"twitter_search_access":true,"user_view_access":"readonly","view_access":"full","view_deleted_tickets":false,"voice_access":true,"voice_dashboard_access":false},"created_at":"2011-07-20T04:31:29Z","description":"A Staff agent's primary role is to solve tickets. They can edit tickets within their groups, view reports, and add or edit personal views and macros.","id":6,"name":"Staff","role_type":0,"team_member_count":10,"updated_at":"2012-02-02T10:32:59Z"}]}