---
title: "Получить роли кабинета"
method: GET
path: "/api/v1/settings/roles"
tags: ["Settings roles"]
---

# Получить роли кабинета

`GET /api/v1/settings/roles`

## Request

- Base URL: `https://erp.akeda.ru`
- URL: `https://erp.akeda.ru/api/v1/settings/roles`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-Api-Key`
  - OAuth 2 (authorization code, authorization URL `https://erp.akeda.ru/oauth2/authorize`, token URL `https://erp.akeda.ru/oauth2/token`, scopes: `akeda:delegate`)

Отдаёт роли кабинета без страниц. Без параметра status в выдачу попадают только действующие роли.

## Query parameters

- `status` 'active' | 'disabled' | 'all'

## Headers

- `X-Tenant` string, required

## Response `200`

Роли кабинета

- SettingsRolePage
  - `count` integer, required: Число строк в results, а не общее число ролей кабинета
  - `results` SettingsRole[], required
    - `id` string, uuid, required
    - `name` string, required
    - `is_admin` boolean, required: У административной роли permissions всегда равны ["*:*"]
    - `is_active` boolean, required
    - `permissions` string[], required: Право записывается как «модуль:действие», например settings:read
    - `record_rules` object, required: Ключ — ресурс модуля: tasks.task, crm.lead, crm.deal, crm.customer, crm.conversation, core.order, docflow.payment_request и ресурсы клиентских модулей. Значение — own (свои), projects (свои и проекты участия, у задач), team (свои и подчинённых), department (своего подразделения), department_tree (подразделения с подотделами) или all (все записи области). Пустая карта означает видимость только своих записей

## Other responses

- `401`: Сессия, ключ или кабинет не подтверждены
- `403`: Текущая роль не имеет требуемого права

---

[API](https://skmtc.dev/akeda/apis/akeda-erp-client-api.md) · [All operations](https://skmtc.dev/akeda/apis/akeda-erp-client-api/llms.txt) · [OpenAPI document](https://skmtc.dev/akeda/apis/akeda-erp-client-api/revisions/3c60ded179f2?raw)