UNunkeyed
permissions

List permissions

Changed on

Retrieve all permissions in your workspace. Results are paginated and sorted by their id.

Required Permissions

Your root key must have the following permission:

  • rbac.*.read_permission
post/v2/permissions.listPermissions

Request

  • Base URL
    https://api.unkey.com
  • URL
    https://api.unkey.com/v2/permissions.listPermissions
  • Auth
    HTTP bearer

Request body

cursorstring

Pagination cursor from a previous response to fetch the next page of permissions. Include this value when you need to retrieve additional permissions beyond the initial response. Each response containing more results than the requested limit includes a cursor for subsequent pages.

Leave empty or omit this field to start from the beginning of the permission list. Cursors are temporary and may expire - always handle cases where a cursor becomes invalid.

limitinteger

Maximum number of permissions to return in a single response.

searchstring

Free-form text to filter permissions. Returns permissions whose ID, name, slug, or description contains the search string. Matching is case-insensitive.

Example request

{
  "cursor": "eyJrZXkiOiJwZXJtXzEyMzQifQ==",
  "limit": 50,
  "search": "documents"
}

Response

Permissions retrieved successfully

Example response

{
  "meta": {
    "requestId": "req_123"
  },
  "data": [
    {
      "id": "perm_1234567890abcdef",
      "name": "users.read",
      "slug": "users-read",
      "description": "Allows reading user profile information and account details"
    }
  ],
  "pagination": {
    "cursor": "eyJrZXkiOiJrZXlfMTIzNCIsInRzIjoxNjk5Mzc4ODAwfQ==",
    "hasMore": true
  }
}

Changes