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

# Key and app permissions

> The permissions a key or app can carry, grouped by data area, with their risk and whether they touch patients.

**When to use it:** Before asking for a new key, to pick only the permissions needed.



## OpenAPI

````yaml /api-reference/openapi.en.json get /platform-policy/permissions
openapi: 3.1.0
info:
  title: Brelio API
  version: '1'
  description: >-
    Everything a person can do in Brelio, a program can do, with the same
    permissions, audit and limits. Every endpoint is derived from the operation
    catalogue.
servers:
  - url: https://api.brelio.app/v1
security: []
paths:
  /platform-policy/permissions:
    get:
      tags:
        - platform-policy
      summary: Key and app permissions
      description: >-
        The permissions a key or app can carry, grouped by data area, with their
        risk and whether they touch patients.


        **When to use it:** Before asking for a new key, to pick only the
        permissions needed.
      operationId: platform-policy.permissions.list
      parameters: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  areas:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          enum:
                            - agenda
                            - team
                            - patients
                            - clinical
                            - billing
                            - integrations
                        label:
                          type: string
                        permissions:
                          type: array
                          items:
                            type: object
                            properties:
                              key:
                                type: string
                              label:
                                type: string
                              risk:
                                type: string
                                enum:
                                  - read
                                  - write
                                  - destructive
                              patientData:
                                type: boolean
                              operations:
                                type: array
                                items:
                                  type: string
                            required:
                              - key
                              - label
                              - risk
                              - patientData
                              - operations
                            additionalProperties: false
                      required:
                        - id
                        - label
                        - permissions
                      additionalProperties: false
                required:
                  - areas
                additionalProperties: false
        '401':
          description: Problem Details (RFC 9457) with a stable `code`
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '402':
          description: Problem Details (RFC 9457) with a stable `code`
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '403':
          description: Problem Details (RFC 9457) with a stable `code`
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '422':
          description: Problem Details (RFC 9457) with a stable `code`
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '429':
          description: Problem Details (RFC 9457) with a stable `code`
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
        '503':
          description: Problem Details (RFC 9457) with a stable `code`
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
      security:
        - bearer: []
components:
  schemas:
    Problem:
      type: object
      required:
        - type
        - title
        - status
        - code
        - detail
        - request_id
        - params
      properties:
        type:
          type: string
        title:
          type: string
        status:
          type: integer
        code:
          type: string
        detail:
          type: string
        request_id:
          type: string
        hint:
          type: string
        retryAfterSeconds:
          type: integer
        params:
          type: object
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: Brelio API key (organization or user) or a WorkOS access token.

````

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