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-cross-space-shares-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 Cross Space Shares 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: cross-space-shares
paths:
/v1/cross-space-shares:
get:
operationId: listCrossSpaceShares
tags:
- cross-space-shares
summary: List cross-workspace shares
description: 'List content this space shares into its child spaces, and content shared with it in turn. A space receiving a share can read it but cannot change or remove it.
**Notes.**
- Lists the shares this workspace RECEIVES (it is the target), not the ones it grants.'
x-brix-permission: playlist.view
x-brix-schema: verified
x-brix-notes:
- Lists the shares this workspace RECEIVES (it is the target), not the ones it grants.
responses:
'200':
description: Success.
content:
application/json:
schema:
type: object
properties:
data:
type: array
items:
type: object
properties:
id:
type: string
sourceSpaceId:
type: string
description: The workspace that shares.
targetSpaceId:
type: string
description: The child workspace that receives.
contentKind:
type: string
description: '`playlist`, `schedule`, `layout`, `creative`, `media`, …'
contentId:
type: string
mode:
type: string
enum:
- linked
- snapshot
description: 'Always `linked` for a new share: the child plays the parent''s current version.'
lockLevel:
type: string
enum:
- playlist
- items
- both
description: What the child cannot change.
lockedItemIds:
type: string
description: A JSON-ENCODED array of item ids (the stored column), not an array.
grantedBy:
type: string
description: The user who shared it; `system` for an API key.
grantedAt:
type: string
description: ISO-8601 timestamp (UTC).
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'
contentName:
anyOf:
- type: string
- type: 'null'
description: Null when the content no longer exists.
sourceSpaceName:
anyOf:
- type: string
- type: 'null'
available:
type: boolean
description: False when the shared content was deleted.
required:
- id
- sourceSpaceId
- targetSpaceId
- contentKind
- contentId
- mode
- lockLevel
- lockedItemIds
- grantedBy
- grantedAt
- createdAt
- updatedAt
- deletedAt
- contentName
- sourceSpaceName
- available
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:
- playlist.view
post:
operationId: createCrossSpaceShare
tags:
- cross-space-shares
summary: Share content with a child workspace
description: 'Share a playlist, layout, schedule, or creative from this space into a child space. The shared content appears in the child space alongside its own content. Only the space that owns the content can create the share. Requires view permission on shares plus the appropriate permission on the content itself.
**Notes.**
- Besides the `playlist.view` gate, the caller needs the content kind''s edit permission at the content''s location.'
x-brix-permission: playlist.view
x-brix-schema: verified
x-brix-notes:
- Besides the `playlist.view` gate, the caller needs the content kind's edit permission at the content's location.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
targetSpaceId:
type: string
description: A child workspace of yours.
contentKind:
type: string
contentId:
type: string
lockLevel:
description: Default `both`.
type: string
enum:
- playlist
- items
- both
lockedItemIds:
type: array
items:
type: string
mode:
description: 'Ignored: a share is always `linked`.'
type: string
required:
- targetSpaceId
- contentKind
- contentId
responses:
'200':
description: 'Success: The content is already shared with that workspace: the existing share is returned.'
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/CrossSpaceShare'
required:
- data
'201':
description: Success.
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/CrossSpaceShare'
required:
- data
'401':
description: Missing, expired or revoked bearer token.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'403':
description: The target is not a child workspace of yours, or you lack the content kind's edit permission (`playlist.edit`, …) where it lives.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: No such content in your workspace.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'422':
description: '`targetSpaceId`, `contentKind` or `contentId` 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:
- playlist.view
/v1/cross-space-shares/{id}:
delete:
operationId: deleteCrossSpaceShare
tags:
- cross-space-shares
summary: Revoke a cross-workspace share
description: 'Withdraw a share. Only the space that created the share can remove it; the receiving space cannot.
**Notes.**
- Only the sharing workspace can revoke; it needs the content kind''s edit permission too.'
x-brix-permission: playlist.view
x-brix-schema: verified
x-brix-notes:
- Only the sharing workspace can revoke; it needs the content kind's edit permission too.
parameters:
- name: id
in: path
required: true
schema:
type: string
description: Share id.
example: xshare_8b9c0d1e2f3a4b5c
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 lack the content kind's edit permission where the content lives.
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
'404':
description: No such share granted by 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:
- playlist.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.
CrossSpaceShare:
type: object
properties:
id:
type: string
sourceSpaceId:
type: string
description: The workspace that shares.
targetSpaceId:
type: string
description: The child workspace that receives.
contentKind:
type: string
description: '`playlist`, `schedule`, `layout`, `creative`, `media`, …'
contentId:
type: string
mode:
type: string
enum:
- linked
- snapshot
description: 'Always `linked` for a new share: the child plays the parent''s current version.'
lockLevel:
type: string
enum:
- playlist
- items
- both
description: What the child cannot change.
lockedItemIds:
type: string
description: A JSON-ENCODED array of item ids (the stored column), not an array.
grantedBy:
type: string
description: The user who shared it; `system` for an API key.
grantedAt:
type: string
description: ISO-8601 timestamp (UTC).
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
- sourceSpaceId
- targetSpaceId
- contentKind
- contentId
- mode
- lockLevel
- lockedItemIds
- grantedBy
- grantedAt
- createdAt
- updatedAt
- deletedAt
description: Content a parent workspace shares with a child workspace.
securitySchemes:
bearerAuth:
type: http
scheme: bearer
description: An API key (`ak_…`) or a user session token. API keys carry `resource.verb` permissions.