Brix Email Health API

openapi: 3.2.0
info:
  title: Brix Email Health 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: email-health
paths:
  /v1/email-health/events:
    get:
      operationId: listEmailHealthEvents
      tags:
      - email-health
      summary: Get email delivery events
      description: 'Returns recent email delivery events for one address, such as deliveries, bounces, and complaints, for use in a per-user delivery history view.


        **Notes.**

        - The newest 50 events. A caller limited to some locations sees only the addresses of people they can see.'
      x-brix-permission: user.view
      x-brix-schema: verified
      x-brix-notes:
      - The newest 50 events. A caller limited to some locations sees only the addresses of people they can see.
      parameters:
      - name: recipient
        in: query
        required: false
        schema:
          type: string
        description: Only events for this address (case-insensitive).
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        recipient:
                          type: string
                        eventType:
                          type: string
                          description: '`delivered`, `bounced`, `complained`, `delivery_delayed`, `sent`, …'
                        reason:
                          anyOf:
                          - type: string
                          - type: 'null'
                        occurredAt:
                          type: string
                          description: ISO-8601 timestamp (UTC).
                      required:
                      - id
                      - recipient
                      - eventType
                      - reason
                      - occurredAt
                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:
        - user.view
  /v1/email-health/failing:
    get:
      operationId: getEmailHealthFailing
      tags:
      - email-health
      summary: List users with failing email
      description: 'Returns the users in the workspace whose email address is currently bouncing or has been marked as spam, so an admin can see who Brix currently cannot reach by email.


        **Notes.**

        - Active people only, limited to the people the caller can see.'
      x-brix-permission: user.view
      x-brix-schema: verified
      x-brix-notes:
      - Active people only, limited to the people the caller can see.
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          description: User id.
                        name:
                          type: string
                        email:
                          type: string
                        failingAt:
                          type: string
                          description: When delivery started to fail.
                        reason:
                          anyOf:
                          - type: string
                          - type: 'null'
                      required:
                      - id
                      - name
                      - email
                      - failingAt
                      - reason
                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:
        - user.view
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.