Brix Screen Groups API

openapi: 3.2.0
info:
  title: Brix Screen Groups 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: screen-groups
paths:
  /v1/screen-groups:
    get:
      operationId: listScreenGroups
      tags:
      - screen-groups
      summary: List screen groups
      description: List the screen groups in your workspace. Each group includes the number of screens in it and the IDs of the screens you have access to see.
      x-brix-permission: screen.view
      x-brix-schema: verified
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/ScreenGroup'
                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:
        - screen.view
    post:
      operationId: createScreenGroup
      tags:
      - screen-groups
      summary: Create a screen group
      description: Create a named group of screens. Optionally pass `screenIds` to add screens to the group at creation time.
      x-brix-permission: screen.edit
      x-brix-schema: verified
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  maxLength: 120
                  description: Unique in the workspace (case-insensitive). Trimmed; longer names are cut at 120.
                description:
                  description: Trimmed; cut at 500 characters.
                  type: string
                screenIds:
                  description: Seed members. Ids you cannot edit are skipped.
                  minItems: 1
                  maxItems: 5000
                  type: array
                  items:
                    type: string
              required:
              - name
      responses:
        '201':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/ScreenGroup'
                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'
        '409':
          description: '`name_taken`: a group with this name exists.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: '`name` missing, or `screenIds` empty / over 5000.'
          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:
        - screen.edit
  /v1/screen-groups/{id}:
    delete:
      operationId: deleteScreenGroup
      tags:
      - screen-groups
      summary: Delete a screen group
      description: Delete a screen group. The screens in the group are not affected, and the group's membership is kept so it can be fully restored with POST /v1/screen-groups/:id/restore.
      x-brix-permission: screen.edit
      x-brix-schema: verified
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Screen group id.
        example: sgrp_7a8b9c0d1e2f3a4b
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                      deleted:
                        type: boolean
                        const: true
                    required:
                    - id
                    - deleted
                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:
        - screen.edit
    get:
      operationId: getScreenGroup
      tags:
      - screen-groups
      summary: Get a screen group
      description: Get one screen group and the screens in it. Requesting a group that belongs to a different workspace returns a not-found error.
      x-brix-permission: screen.view
      x-brix-schema: verified
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Screen group id.
        example: sgrp_7a8b9c0d1e2f3a4b
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/ScreenGroup'
                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'
        '404':
          description: No such group 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:
        - screen.view
    patch:
      operationId: updateScreenGroup
      tags:
      - screen-groups
      summary: Rename a screen group
      description: Update a screen group's name or description. A name already used by another group in your workspace is refused with a `name_taken` conflict error.
      x-brix-permission: screen.edit
      x-brix-schema: verified
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Screen group id.
        example: sgrp_7a8b9c0d1e2f3a4b
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  minLength: 1
                description:
                  anyOf:
                  - type: string
                  - type: 'null'
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/ScreenGroup'
                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'
        '404':
          description: No screen group with this id.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: '`name_taken`.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: '`name` is empty.'
          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:
        - screen.edit
  /v1/screen-groups/{id}/restore:
    post:
      operationId: restoreScreenGroup
      tags:
      - screen-groups
      summary: Restore a deleted screen group
      description: Restore a deleted screen group along with its original screen membership. A group that is not currently deleted is refused with a conflict error.
      x-brix-permission: screen.edit
      x-brix-schema: verified
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Screen group id.
        example: sgrp_7a8b9c0d1e2f3a4b
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/ScreenGroup'
                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'
        '404':
          description: No screen group with this id.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: '`not_deleted`, or a live group has the same name.'
          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:
        - screen.edit
  /v1/screen-groups/{id}/screens:
    post:
      operationId: addScreensToGroup
      tags:
      - screen-groups
      summary: Add screens to a group
      description: Add screens to a group. Adding a screen already in the group has no additional effect. A screen from another workspace, a deleted screen, or a screen outside your organization scope is skipped and counted in the response, but not identified individually.
      x-brix-permission: screen.edit
      x-brix-schema: verified
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Screen group id.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                screenIds:
                  minItems: 1
                  maxItems: 5000
                  type: array
                  items:
                    type: string
                  description: Screen ids (1–5000). Ids you cannot edit, or that do not exist, are skipped.
              required:
              - screenIds
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                      added:
                        type: integer
                        description: Screens newly added (existing members are not counted).
                      skipped:
                        type: integer
                        description: Requested ids that do not exist or that the caller cannot edit.
                      screenIds:
                        type: array
                        items:
                          type: string
                        description: The screens newly added.
                    required:
                    - id
                    - added
                    - skipped
                    - screenIds
                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'
        '404':
          description: No such group.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: '`screenIds` empty or over 5000.'
          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:
        - screen.edit
  /v1/screen-groups/{id}/screens/{screenId}:
    delete:
      operationId: deleteScreenGroupScreen
      tags:
      - screen-groups
      summary: Remove a screen from a group
      description: Remove one screen from a group. Returns a not-found error if the screen is not currently in the group.
      x-brix-permission: screen.edit
      x-brix-schema: verified
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Screen group id.
        example: sgrp_7a8b9c0d1e2f3a4b
      - name: screenId
        in: path
        required: true
        schema:
          type: string
        description: Screen id.
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                      removed:
                        type: integer
                        description: 1 when the screen was a member, else 0.
                      screenIds:
                        type: array
                        items:
                          type: string
                        description: The remaining members the caller can see.
                    required:
                    - id
                    - removed
                    - screenIds
                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:
        - screen.edit
  /v1/screen-groups/{id}/screens/remove:
    post:
      operationId: removeScreensFromGroup
      tags:
      - screen-groups
      summary: Remove screens from a group
      description: Remove one or more screens from a group. This only removes the screens from the group; the screens themselves are not affected. Removing a screen that is not in the group has no effect.
      x-brix-permission: screen.edit
      x-brix-schema: verified
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Screen group id.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                screenIds:
                  minItems: 1
                  maxItems: 5000
                  type: array
                  items:
                    type: string
                  description: Screen ids (1–5000). Ids you cannot edit, or that do not exist, are skipped.
              required:
              - screenIds
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                      removed:
                        type: integer
                      skipped:
                        type: integer
                        description: Requested ids that do not exist or that the caller cannot edit.
                      screenIds:
                        type: array
                        items:
                          type: string
                        description: The screens removed.
                    required:
                    - id
                    - removed
                    - skipped
                    - screenIds
                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'
        '404':
          description: No such group.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: '`screenIds` empty or over 5000.'
          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:
        - screen.edit
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.
    ScreenGroup:
      type: object
      properties:
        id:
          type: string
          description: Screen group id.
          examples:
          - sgrp_7a8b9c0d1e2f3a4b
        name:
          type: string
        description:
          anyOf:
          - type: string
          - type: 'null'
        screenCount:
          type: integer
          description: Members the caller can see.
        screenIds:
          type: array
          items:
            type: string
          description: Member screen ids the caller can see, oldest membership first.
        createdAt:
          type: string
          description: ISO-8601 timestamp (UTC).
        updatedAt:
          type: string
          description: ISO-8601 timestamp (UTC).
      required:
      - id
      - name
      - description
      - screenCount
      - screenIds
      - createdAt
      - updatedAt
      description: A named, saved set of screens — the unit for bulk commands and casts.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: An API key (`ak_…`) or a user session token. API keys carry `resource.verb` permissions.