Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
All 92 tools →
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/brixsignage-com:brixsignage-com-banners-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Brix Banners 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: banners
paths:
/v1/banners:
get:
operationId: listBanners
tags:
- banners
summary: List banners
description: List the announcement banners this workspace has created for display inside the content management system, including each banner's title, body, tone, audience, and active state.
x-brix-permission: integration.view
x-brix-schema: verified
parameters:
- name: limit
in: query
required: false
schema:
type: integer
minimum: 1
maximum: 200
description: Page size. Omit to get every row; pass it to page by `cursor`.
- name: cursor
in: query
required: false
schema:
type: string
description: The `nextCursor` of the previous page.
- name: count
in: query
required: false
schema:
type: string
enum:
- '1'
description: 'With `limit`: also return `total`, the number of matching rows.'
- name: usableAt
in: query
required: false
schema:
type: string
description: 'Location id: only rows usable at that location (homed there, at the workspace root, or shared to it).'
responses:
'200':
description: Success.
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/Banner'
nextCursor:
description: Present when `?limit` was passed. Send it back as `?cursor=` for the next page; null on the last page.
anyOf:
- type: string
- type: 'null'
total:
description: Total matching rows, when the route computes it.
type: integer
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:
- integration.view
post:
operationId: createBanner
tags:
- banners
summary: Create a banner
description: 'Create an announcement banner with a `title` and optional `body`, `tone`, `audience`, and `active` state. `tone` defaults to "info" when not specified.
**Notes.**
- The 201 body is the row as written, not re-read from the database, so columns the create does not set (for example `lastSnapshotAt`) are absent rather than null. `GET` returns every column.'
x-brix-permission: integration.create
x-brix-schema: verified
x-brix-notes:
- The 201 body is the row as written, not re-read from the database, so columns the create does not set (for example `lastSnapshotAt`) are absent rather than null. `GET` returns every column.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
title:
type: string
body:
anyOf:
- type: string
- type: 'null'
tone:
description: Default `info`.
type: string
enum:
- info
- success
- warning
- critical
audience:
type: object
propertyNames:
type: string
additionalProperties: {}
active:
description: Default true.
type: boolean
required:
- title
example:
title: Staff meeting at 3
body: Break room
tone: warning
responses:
'201':
description: Success.
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/Banner'
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'
'422':
description: '`title` is missing.'
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:
- integration.create
/v1/banners/{id}:
delete:
operationId: deleteBanner
tags:
- banners
summary: Delete a banner
description: Delete an announcement banner.
x-brix-permission: integration.delete
x-brix-schema: verified
parameters:
- name: id
in: path
required: true
schema:
type: string
description: Banner id.
example: ban_4d5e6f7a8b9c0d1e
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'
'404':
description: No such banner 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:
- integration.delete
get:
operationId: getBanner
tags:
- banners
summary: Get a banner
description: Retrieve one announcement banner.
x-brix-permission: integration.view
x-brix-schema: verified
parameters:
- name: id
in: path
required: true
schema:
type: string
description: Banner id.
example: ban_4d5e6f7a8b9c0d1e
responses:
'200':
description: Success.
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/Banner'
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 banner 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:
- integration.view
patch:
operationId: updateBanner
tags:
- banners
summary: Update a banner
description: Edit an announcement banner's title, body, tone, audience, or active state.
x-brix-permission: integration.edit
x-brix-schema: verified
parameters:
- name: id
in: path
required: true
schema:
type: string
description: Banner id.
example: ban_4d5e6f7a8b9c0d1e
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
title:
type: string
body:
anyOf:
- type: string
- type: 'null'
tone:
description: Default `info`.
type: string
enum:
- info
- success
- warning
- critical
audience:
type: object
propertyNames:
type: string
additionalProperties: {}
active:
description: Default true.
type: boolean
responses:
'200':
description: Success.
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/Banner'
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 banner 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:
- integration.edit
/v1/banners/{id}/restore:
post:
operationId: restoreBanner
tags:
- banners
summary: Restore a banner
description: Restore a previously deleted announcement banner so it is active again.
x-brix-permission: integration.delete
x-brix-schema: verified
parameters:
- name: id
in: path
required: true
schema:
type: string
description: Banner id.
example: ban_4d5e6f7a8b9c0d1e
responses:
'200':
description: Success.
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
id:
type: string
restored:
type: boolean
const: true
required:
- id
- restored
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 banner in this workspace, or it was purged.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'409':
description: '`not_deleted`: the banner is not in the recycle bin.'
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:
- integration.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.
Banner:
type: object
properties:
id:
type: string
spaceId:
type: string
title:
type: string
body:
anyOf:
- type: string
- type: 'null'
tone:
type: string
enum:
- info
- success
- warning
- critical
audience:
type: object
propertyNames:
type: string
additionalProperties: {}
description: Free-form JSON the screens use to pick the banner (default `{}`).
active:
type: boolean
createdAt:
type: string
description: ISO-8601 timestamp (UTC).
updatedAt:
type: string
description: ISO-8601 timestamp (UTC).
deletedAt:
anyOf:
- type: string
description: ISO-8601 timestamp (UTC).
- type: 'null'
required:
- id
- spaceId
- title
- body
- tone
- audience
- active
- createdAt
- updatedAt
- deletedAt
description: A workspace message banner shown on screens.
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: An API key (`ak_…`) or a user session token. API keys carry `resource.verb` permissions.