---
title: "GET /api/v1/roles/permissions"
method: GET
path: "/api/v1/roles/permissions"
tags: ["Roles"]
---

# GET /api/v1/roles/permissions

`GET /api/v1/roles/permissions`

## Request

- Base URL: `https://api.immy.bot` (the document declares no server; this is the origin it was published from)
- URL: `https://api.immy.bot/api/v1/roles/permissions`
- Auth: none declared

## Response `200`

OK

- ISubjectMetadata[]
  - `id` string, nullable
  - `name` string, nullable
  - `displayName` string, nullable
  - `description` string, nullable
  - `sortOrder` integer
  - `permissions` IPermissionMetadata[], nullable
    - `id` string, nullable
    - `permissionName` string, nullable
    - `displayName` string, nullable
    - `description` string, nullable
    - `category` 'View' | 'CoreCapability' | 'Advanced': The string or integer value may be used. View = 0, CoreCapability = 1, Advanced = 2
    - `sortOrder` integer
    - `hasGreatPower` boolean
    - `dependencies` IPermissionMetadata[], nullable
    - `subject` ISubjectMetadata (recursive)
    - `isMspOnly` boolean
    - `isSystemManaged` boolean
    - `allowClaim` string, nullable
    - `subjectPermissionClaimType` string, nullable
  - `isMspOnly` boolean
  - `isResourceBased` boolean
  - `isSystemManaged` boolean

---

[API](https://skmtc.dev/immy/apis/immy-bot-api-2.md) · [All operations](https://skmtc.dev/immy/apis/immy-bot-api-2/llms.txt) · [OpenAPI document](https://skmtc.dev/immy/apis/immy-bot-api-2/revisions/75b50268fa51?raw)