mocop
Browse · Docs · Guide · Analyze

Brix API

API by Brix · rest

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. 464 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": "<code>", "message": "…" }, plus requestId on a 5xx.…

Endpoint: https://api.brixsignage.com/

Verification: observed. Source: crawl.

Capabilities (531)

  • Get account overview
  • Answer the first-sign-in questions
  • Get billing address
  • Set billing address
  • Switch billing mode
  • Choose a plan
  • Switch plan cadence
  • List screens on the plan
  • Choose which screens play
  • Get plan screen counts
  • Quote a plan
  • Change plan screens
  • Price a screen change
  • Request more screens
  • Set the plan for the trial's end
  • Remove the plan for the trial's end
  • Cancel subscription
  • Cancel pending account deletion
  • Get the default content scope
  • Set the default content scope
  • Set contract auto-renewal
  • Get data inventory
  • Switch to monthly billing
  • Get encryption key status
  • Enable customer-managed key
About · Contact · Privacy