Brix Connected Apps API

openapi: 3.2.0
info:
  title: Brix Connected Apps API
  version: '1'
  summary: 'Control plane for Brix digital signage: screens, content, playlists, schedules, casts and emergencies.'
  description: 'Generated from the route table the API actually mounts

    (`apps/api/routes.snapshot.json`), the description each route is required to

    carry (`tests/contracts/route-registry.json`), and request/response schemas

    (`apps/api/src/openapi/`). CI enforces all three, so this document cannot list a

    route that does not exist or omit one that does.


    **Schemas.** 447 operations carry request and response schemas

    (`x-brix-schema: verified`). Each is checked in CI against the response the

    real handler returns — a missing, mistyped or undeclared field fails the build.

    The remaining operations are route-level only (`x-brix-schema: none`): their

    path, method, permission and purpose are exact, but the shape of `data` is not

    yet modelled, and we would rather say so than publish a schema that validates

    against nothing. Objects are open: a new field is not a breaking change.


    **Envelope.** Success bodies are `{ "data": … }`. Failures are

    `{ "error": "", "message": "…" }`, plus `requestId` on a 5xx.

    Many list routes page opt-in (see each operation): pass `?limit=` and

    follow `nextCursor` via `?cursor=` until it is null.


    **Authentication.** `Authorization: Bearer ` with an API key

    (`ak_…`, created in the console under Settings → API & MCP) or a user session. An

    API key carries a creator-chosen set of `resource.verb` permissions and may be

    pinned to one location''s subtree; a key can never be granted a permission its

    creator does not hold. The permission an operation needs is in

    `x-brix-permission` and in its security requirement.


    **Tenancy.** Every request resolves to one workspace. A resource belonging to

    another tenant returns 404, never 403, so a response never confirms that an

    account exists.


    **Rate limits.** A 429 carries `Retry-After`; a 503 `database_busy` means retry

    after the `Retry-After` interval.'
servers:
- url: https://api.brixsignage.com
  description: Production
security:
- bearerAuth: []
tags:
- name: connected-apps
paths:
  /v1/connected-apps:
    get:
      operationId: listConnectedApps
      tags:
      - connected-apps
      summary: List connected apps
      description: 'Returns the AI assistants and other MCP clients that people in this workspace connected with OAuth: the client, who connected it, its permissions, the location it is pinned to, and when it was last used. You see a connection only where you hold the permission to view API keys at its location.


        **Notes.**

        - Newest first. Only connections whose location the caller can see with `api-key.view` are listed.'
      x-brix-permission: api-key.view
      x-brix-schema: verified
      x-brix-notes:
      - Newest first. Only connections whose location the caller can see with `api-key.view` are listed.
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: Connection id.
                        clientId:
                          type: string
                        clientName:
                          type: string
                          description: The app's name, as it registered.
                        redirectHost:
                          anyOf:
                          - type: string
                          - type: 'null'
                          description: The host the app signs in through.
                        connectedBy:
                          anyOf:
                          - type: object
                            properties:
                              id:
                                type: string
                              name:
                                type: string
                              email:
                                type: string
                            required:
                            - id
                            - name
                            - email
                          - type: 'null'
                          description: The person who approved it; null if they no longer exist.
                        permissions:
                          anyOf:
                          - type: string
                            const: all
                          - type: array
                            items:
                              type: string
                        nodeId:
                          anyOf:
                          - type: string
                          - type: 'null'
                          description: The location the connection is limited to; null for the whole workspace.
                        lastUsedAt:
                          anyOf:
                          - type: string
                            description: ISO-8601 timestamp (UTC).
                          - type: 'null'
                        connectedAt:
                          type: string
                          description: ISO-8601 timestamp (UTC).
                        recent:
                          anyOf:
                          - type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: string
                                action:
                                  type: string
                                  description: The audit action, e.g. `playlist.updated`.
                                summary:
                                  type: string
                                  description: The action in words, e.g. "Playlist updated".
                                detail:
                                  anyOf:
                                  - type: string
                                  - type: 'null'
                                at:
                                  type: string
                                  description: ISO-8601 timestamp (UTC).
                              required:
                              - id
                              - action
                              - summary
                              - detail
                              - at
                          - type: 'null'
                          description: The connection's latest actions (up to 5), newest first. Null without `audit-log.view`.
                      required:
                      - id
                      - clientId
                      - clientName
                      - redirectHost
                      - connectedBy
                      - permissions
                      - nodeId
                      - lastUsedAt
                      - connectedAt
                      - recent
                required:
                - data
        '401':
          description: Missing, expired or revoked bearer token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: The token lacks the permission this operation needs (see `x-brix-permission`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        5XX:
          description: Server error. The body carries a `requestId` to quote to support.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - bearerAuth:
        - api-key.view
  /v1/connected-apps/{id}:
    delete:
      operationId: deleteConnectedApp
      tags:
      - connected-apps
      summary: Disconnect connected app
      description: 'Disconnects an app that was connected with OAuth. Its access stops immediately. You must hold the permission to delete API keys at the location the connection is pinned to.


        **Notes.**

        - Answers the same for a connection that was already revoked.'
      x-brix-permission: api-key.delete
      x-brix-schema: verified
      x-brix-notes:
      - Answers the same for a connection that was already revoked.
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Connection id.
        example: oag_5e6f7a8b9c0d1e2f
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                      revoked:
                        type: boolean
                        const: true
                    required:
                    - id
                    - revoked
                required:
                - data
        '401':
          description: Missing, expired or revoked bearer token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: You do not hold `api-key.delete` where the connection is limited to.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No such connection in this workspace.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        5XX:
          description: Server error. The body carries a `requestId` to quote to support.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
      - bearerAuth:
        - api-key.delete
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
          description: 'Machine-readable code: `unauthorized`, `forbidden`, `not_found`, `validation_error`, `conflict`, `rate_limited`, `internal_error`, …'
        message:
          description: Human-readable explanation. Safe to show an operator.
          type: string
        requestId:
          description: 'Present on 5xx: quote it to support.'
          type: string
      required:
      - error
      additionalProperties: {}
      description: Error envelope returned by every failing request.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: An API key (`ak_…`) or a user session token. API keys carry `resource.verb` permissions.