---
title: "List permissions"
method: GET
path: "/user_risk/permissions/list"
tags: ["userrisk"]
---

# List permissions

`GET /user_risk/permissions/list`

## Request

- Base URL: `https://cyber-risk.upguard.com/api/public`
- URL: `https://cyber-risk.upguard.com/api/public/user_risk/permissions/list`
- Auth: API key in header `Authorization`
- TypeScript: <https://skmtc.dev/upguard/apis/upguard-cyberrisk-api/docs/user_risk/permissions/list/get.ts> (a function with typed inputs; its response is checked against the schema)

Retrieve a list of permissions for your organization.

Required API key permissions: `User Risk` (select when creating API key in Account Settings)

## Query parameters

- `page_size` integer
- `page_token` string
- `sort_by` 'id' | 'name' | 'exposure_level' | 'times_granted'
- `sort_dir` 'asc' | 'desc'
- `categories` string[]
- `access_level` string[]
- `exposure_level` string[]

## Response `200`

A list of permissions for your organization

- GetUserRiskPermissionsListResponse
  - `next_page_token` string: The token to be used to retrieve the next page of results. Will not be returned if there are no more results.
  - `permissions` Permission[], required: The list of permissions.
    - `access_level` 'read_only' | 'read_write', string, required: The access level granted by the permission.
    - `category` string: The category of the permission.
    - `description` string, required: A description of what the permission allows.
    - `exposure_level` 'basic' | 'elevated', string, required: The risk level associated with the application or permission.
    - `id` string, required: The unique identifier of the permission.
    - `name` string, required: The name of the permission.
    - `times_granted` integer, required: The number of times this permission has been granted across all users and apps.

## Other responses

- `403`: Your API key does not have permission to perform this action.
- `422`: An invalid parameter was supplied or a mandatory parameter was missing
- `429`: Too many requests have been made to this endpoint.
- `500`: An internal system error occurred

---

[API](https://skmtc.dev/upguard/apis/upguard-cyberrisk-api.md) - [All operations](https://skmtc.dev/upguard/apis/upguard-cyberrisk-api/llms.txt) - [OpenAPI document](https://skmtc.dev/upguard/apis/upguard-cyberrisk-api/revisions/d044bf6dc61e?raw)