> ## 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.

# Data integrations may use

> Which data areas (schedule, team, patients, billing) the clinic allows assistants and integrations to use.

**When to use it:** When an operation answers DATA_AREA_OFF, to see what is off and tell the person.



## OpenAPI

````yaml /api-reference/openapi.en.json get /platform-policy
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:
    get:
      tags:
        - platform-policy
      summary: Data integrations may use
      description: >-
        Which data areas (schedule, team, patients, billing) the clinic allows
        assistants and integrations to use.


        **When to use it:** When an operation answers DATA_AREA_OFF, to see what
        is off and tell the person.
      operationId: platform-policy.list
      parameters: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          enum:
                            - agenda
                            - team
                            - patients
                            - clinical
                            - billing
                          description: >-
                            Data area: agenda, team (services and team),
                            patients (administrative data), clinical (clinical
                            history) or billing.
                        label:
                          type: string
                        description:
                          type: string
                        patientData:
                          type: boolean
                        enabled:
                          type: boolean
                        version:
                          type: integer
                          minimum: -9007199254740991
                          maximum: 9007199254740991
                          description: >-
                            Version of the area; 0 while it is on its default.
                            Send it back as expectedVersion.
                        updatedAt:
                          anyOf:
                            - type: string
                              format: date-time
                              pattern: >-
                                ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
                              description: ISO 8601, UTC.
                            - type: 'null'
                      required:
                        - id
                        - label
                        - description
                        - patientData
                        - enabled
                        - version
                        - updatedAt
                      additionalProperties: false
                  terms:
                    type: object
                    properties:
                      id:
                        type: string
                        const: patient-data-terms
                      version:
                        type: integer
                        minimum: -9007199254740991
                        maximum: 9007199254740991
                      reviewed:
                        type: boolean
                      available:
                        type: boolean
                    required:
                      - id
                      - version
                      - reviewed
                      - available
                    additionalProperties: false
                required:
                  - data
                  - terms
                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.