> ## Documentation Index
> Fetch the complete documentation index at: https://docs.veridox.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Role Permissions

> See which permissions each role holds in your organisation.

Returns the permissions in force for each role in your organisation. For each role and permission, `granted` says whether the role holds it, and `is_override` says whether that value was set for your organisation rather than taken from the default.

## Permission

Requires `organisation_settings:read`, which the Owner and Admin roles hold by default. A caller without it receives `403`.

## Role Names

`role_permissions` is keyed by these role values:

| Role | Value |
| - | - |
| Owner | `organisation_owner` |
| Admin | `organisation_admin` |
| Analyst | `analyst` |
| Member | `member` |

## Changing Role Permissions

Anyone with `organisation_settings:write` changes role permissions in the Veridox dashboard. This is not available through the API.

## Related

* [Permissions and API Keys](/guides/permissions.md) describes each permission and its defaults.


## OpenAPI

````yaml GET /organisations/role-permissions
openapi: 3.1.0
info:
  title: Veridox Core API
  description: Veridox Core Platform API
  version: 0.0.1
  contact: {}
servers:
  - url: https://api.uk.veridox.ai
    description: Live (UK)
  - url: https://api.ca.veridox.ai
    description: Live (CA)
security: []
tags:
  - name: Status
    description: System status and health check endpoints
  - name: Cases
    description: Case and case file management
  - name: Organisations
    description: Organisation management
  - name: Document Requests
    description: Document request management
  - name: Search
    description: Search functionality
  - name: Admin
    description: Administrative endpoints
paths:
  /organisations/role-permissions:
    get:
      tags:
        - Organisations
      summary: Get effective role-permission matrix
      description: >-
        Returns the fully-resolved role-permission matrix for the organisation —
        every role and every permission, each with its effective granted value
        and whether it comes from an org override or the code default. Requires
        organisation_settings:read.
      operationId: OrganisationsController_getRolePermissions
      parameters: []
      responses:
        '200':
          description: Role permissions retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetRolePermissionsResponseDto'
        '401':
          description: Unauthorized (invalid or missing authentication token)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDto'
        '403':
          description: Caller lacks organisation_settings:read
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDto'
        '429':
          description: Too many requests (rate limit exceeded)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorDto'
      security:
        - api-key: []
components:
  schemas:
    GetRolePermissionsResponseDto:
      type: object
      properties:
        role_permissions:
          type: object
          propertyNames:
            type: string
            enum:
              - organisation_owner
              - organisation_admin
              - analyst
              - member
          additionalProperties:
            type: object
            propertyNames:
              type: string
              enum:
                - organisation_cases:read
                - organisation_cases:write
                - organisation_files:read
                - organisation_files:write
                - organisation_files:reassign
                - organisation_files:override_risk_score
                - organisation_files:delete
                - organisation_files:purge
                - organisation_members:read
                - organisation_members:write
                - organisation_teams:read
                - organisation_teams:write
                - organisation_teams:delete
                - organisation_settings:read
                - organisation_settings:write
                - billing:read
                - billing:write
            additionalProperties:
              type: object
              properties:
                granted:
                  type: boolean
                is_override:
                  type: boolean
              required:
                - granted
                - is_override
            required:
              - organisation_cases:read
              - organisation_cases:write
              - organisation_files:read
              - organisation_files:write
              - organisation_files:reassign
              - organisation_files:override_risk_score
              - organisation_files:delete
              - organisation_files:purge
              - organisation_members:read
              - organisation_members:write
              - organisation_teams:read
              - organisation_teams:write
              - organisation_teams:delete
              - organisation_settings:read
              - organisation_settings:write
              - billing:read
              - billing:write
          required:
            - organisation_owner
            - organisation_admin
            - analyst
            - member
          x-nestjs_zod-uses-3-point-1-syntax: true
          x-nestjs_zod-self-required: true
      required:
        - role_permissions
    ErrorDto:
      type: object
      properties:
        error_code:
          type: string
          description: Machine-readable error code for programmatic handling
          examples:
            - request.cases.file.missing-risk-score
            - request.authentication.invalid-token
            - request.forbidden
            - request.cases.case.not-found
            - request.cases.case.already-locked
        error_message:
          type: string
          description: Human-readable error message explaining what went wrong
          example: >-
            User tried to perform an invalid operation on a file without a risk
            score.
        error_details:
          type: object
          example:
            field: email_address
      required:
        - error_code
        - error_message
  securitySchemes:
    api-key:
      type: apiKey
      in: header
      name: x-api-key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.