---
title: "Retrieve a role"
method: GET
path: "/roles/{name}"
tags: ["User"]
---

# Retrieve a role

`GET /roles/{name}`

Retrieves the settings of a role.

## Path parameters

- `name` string, required — Roles include built-in roles and custom roles. Built-in roles roles cannot be modified. Also, the names of built-in roles are reserved words, custom roles are not allowed to use these names to avoid unnecessary confusion. Built-in roles include: - `SystemAdmin`: the system administrator has almost all permissions. - `Replicator`: the application permissions collection. - `Dealer`: the sales manager has all sold tenant resource permissions - `Admin`: the admin has all tenant-wide resource permissions. - `StandardUser`: the user all user-wide resource permissions. - `StandardInternationalUser`: the user all user-wide resource permissions with international call permissions. - `QueueManager`: The call queue manager.

## Response `200`

OK

- object
  - `name` string — Roles include built-in roles and custom roles. Built-in roles roles cannot be modified. Also, the names of built-in roles are reserved words, custom roles are not allowed to use these names to avoid unnecessary confusion. Built-in roles include: - `SystemAdmin`: the system administrator has almost all permissions. - `Replicator`: the application permissions collection. - `Dealer`: the sales manager has all sold tenant resource permissions - `Admin`: the admin has all tenant-wide resource permissions. - `StandardUser`: the user all user-wide resource permissions. - `StandardInternationalUser`: the user all user-wide resource permissions with international call permissions. - `QueueManager`: The call queue manager.
  - `permissions` object — The permission list of role.
    - `general` object
      - `voicemail_view_only` boolean — The flag whether the permission is enabled.
      - `voicemail_full_access` boolean — The flag whether the permission is enabled.
      - `meeting` boolean — The flag whether the permission is enabled.
    - `system` object
      - `information` boolean — The flag whether the permission is enabled.
      - `dealer` boolean — The flag whether the permission is enabled.
      - `tenant` boolean — The flag whether the permission is enabled.
    - `trunk` object
      - `view_only` boolean — The flag whether the permission is enabled.
      - `full_access` boolean — The flag whether the permission is enabled.
    - `company` object
      - `view_only` boolean — The flag whether the permission is enabled.
      - `full_access` boolean — The flag whether the permission is enabled.
    - `company_call_log` object
      - `call_log_view_only` boolean — The flag whether the permission is enabled.
      - `call_log_full_access` boolean — The flag whether the permission is enabled.
      - `call_recording_view_only` boolean — The flag whether the permission is enabled.
      - `call_recording_full_access` boolean — The flag whether the permission is enabled.
    - `phone_system` object
      - `view_only` boolean — The flag whether the permission is enabled.
      - `full_access` boolean — The flag whether the permission is enabled.
    - `user_management` object
      - `roles` boolean — The flag whether the permission is enabled.
      - `users` boolean — The flag whether the permission is enabled.
    - `user_call_log` object
      - `call_log_view_only` boolean — The flag whether the permission is enabled.
      - `call_log_full_access` boolean — The flag whether the permission is enabled.
      - `call_recording_view_only` boolean — The flag whether the permission is enabled.
      - `call_recording_full_access` boolean — The flag whether the permission is enabled.
    - `policies` object
      - `domestic_calls` boolean — The flag whether the permission is enabled.
      - `internal_calls` boolean — The flag whether the permission is enabled.
      - `international_calls` boolean — The flag whether the permission is enabled.
    - `analytics` object
      - `call_report_view_only` boolean — The flag whether the permission is enabled.
      - `call_report_full_access` boolean — The flag whether the permission is enabled.
    - `billing` object
      - `view_only` boolean — The flag whether the permission is enabled.
      - `full_access` boolean — The flag whether the permission is enabled.
  - `description` string — Role's description.

## Other responses

- `4XX` — Error

---

[API](https://skmtc.net/portsip/apis/portsip-pbx-rest-api.md) · [All operations](https://skmtc.net/portsip/apis/portsip-pbx-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/portsip/portsip-pbx-rest-api/revisions/577415d4a3d5/schema)