---
title: "Show Custom Role"
method: GET
path: "/api/v2/custom_roles/{custom_role_id}"
tags: ["Custom Roles"]
---

# Show Custom Role

`GET /api/v2/custom_roles/{custom_role_id}`

#### Availability

* Accounts on the Enterprise plan or above

#### Allowed for

* Administrators
* Agents with the `manage_roles` permission

## Response `200`

Success response

- CustomRoleResponse
  - `custom_role` CustomRoleObject
    - `configuration` CustomRoleConfigurationObject — Configuration settings for the role. See [Configuration](#configuration)
      - `assign_tickets_to_any_group` boolean — Whether or not the agent can assign tickets to any group
      - `chat_access` boolean — Whether or not the agent has access to Chat
      - `end_user_list_access` string — Whether or not the agent can view lists of user profiles. Allowed values: "full", "none"
      - `end_user_profile_access` string — What the agent can do with end-user profiles. Allowed values: "edit", "edit-within-org", "full", "readonly"
      - `explore_access` string — Allowed values: "edit", "full", "none", "readonly"
      - `forum_access` string — The kind of access the agent has to Guide. Allowed values: "edit-topics", "full", "readonly"
      - `forum_access_restricted_content` boolean
      - `group_access` boolean — Whether or not the agent can add or modify groups
      - `light_agent` boolean
      - `macro_access` string — What the agent can do with macros. Allowed values: "full", "manage-group", "manage-personal", "readonly"
      - `manage_business_rules` boolean — Whether or not the agent can manage business rules
      - `manage_contextual_workspaces` boolean — Whether or not the agent can view, add, and edit contextual workspaces
      - `manage_dynamic_content` boolean — Whether or not the agent can access dynamic content
      - `manage_extensions_and_channels` boolean — Whether or not the agent can manage channels and extensions
      - `manage_facebook` boolean — Whether or not the agent can manage Facebook pages
      - `manage_organization_fields` boolean — Whether or not the agent can create and manage organization fields
      - `manage_ticket_fields` boolean — Whether or not the agent can create and manage ticket fields
      - `manage_ticket_forms` boolean — Whether or not the agent can create and manage ticket forms
      - `manage_user_fields` boolean — Whether or not the agent can create and manage user fields
      - `moderate_forums` boolean
      - `organization_editing` boolean — Whether or not the agent can add or modify organizations
      - `organization_notes_editing` boolean — Whether or not the agent can add or modify organization notes
      - `report_access` string — What the agent can do with reports. Allowed values: "full", "none", "readonly"
      - `side_conversation_create` boolean — Whether or not the agent can contribute to side conversations
      - `ticket_access` string — What kind of tickets the agent can access. Allowed values: "all", "assigned-only", "within-groups", "within-groups-and-public-groups", "within-organization"
      - `ticket_comment_access` string — What type of comments the agent can make. Allowed values: "public", "none"
      - `ticket_deletion` boolean — Whether or not the agent can delete tickets
      - `ticket_editing` boolean — Whether or not the agent can edit ticket properties
      - `ticket_merge` boolean — Whether or not the agent can merge tickets
      - `ticket_tag_editing` boolean — Whether or not the agent can edit ticket tags
      - `twitter_search_access` boolean
      - `user_view_access` string — What the agent can do with customer lists. Allowed values: "full", "manage-group", "manage-personal", "none", "readonly"
      - `view_access` string — What the agent can do with views. Allowed values: "full", "manage-group", "manage-personal", "playonly", "readonly"
      - `view_deleted_tickets` boolean — Whether or not the agent can view deleted tickets
      - `voice_access` boolean — Whether or not the agent can answer and place calls to end users
      - `voice_dashboard_access` boolean — Whether or not the agent can view details about calls on the Talk dashboard
    - `created_at` string, date-time — The time the record was created
    - `description` string — A description of the role
    - `id` integer — Automatically assigned on creation
    - `name` string, required — Name of the custom role
    - `role_type` integer, required — The user's role. 0 stands for a custom agent, 1 for a light agent, 2 for a chat agent, 3 for a contributor, 4 for an admin and 5 for a billing admin. See [Understanding standard agent roles in Zendesk Support](https://support.zendesk.com/hc/en-us/articles/4409155971354-Understanding-standard-agent-roles-in-Zendesk-Support) in Zendesk help
    - `team_member_count` integer — The number of team members assigned to this role
    - `updated_at` string, date-time — The time the record was last updated

---

[API](https://skmtc.dev/botbrains-io/apis/support-api.md) · [All operations](https://skmtc.dev/botbrains-io/apis/support-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/botbrains-io/support-api/revisions/d53eac07ba68/schema)