---
title: "List roles"
method: GET
path: "/roles"
tags: ["User"]
---

# List roles

`GET /roles`

## Request

- Base URL: `https://HOSTNAME:8887/api`
- URL: `https://HOSTNAME:8887/api/roles`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/portsip/apis/portsip-pbx-rest-api/docs/roles/get.ts> (a function with typed inputs; its response is checked against the schema)

List a collection of roles.

## Query parameters

- `filter` string
- `search` string
- `orderby` string
- `skip` integer
- `top` integer

## Response `200`

OK

- object
  - `count` integer: Total number of resource.
  - `items` 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.
    - `description` string: Role's description.

## Other responses

- `4XX`: Error

---

[API](https://skmtc.dev/portsip/apis/portsip-pbx-rest-api.md) - [All operations](https://skmtc.dev/portsip/apis/portsip-pbx-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/portsip/apis/portsip-pbx-rest-api/revisions/577415d4a3d5?raw)