Brix Social Accounts API

openapi: 3.2.0
info:
  title: Brix Social Accounts 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: social-accounts
paths:
  /v1/social-accounts:
    get:
      operationId: listSocialAccounts
      tags:
      - social-accounts
      summary: List social accounts
      description: 'List the social accounts connected to your workspace. Use the provider query parameter, for example provider=youtube, to filter by provider. Each result includes the display name and connection status for the account, but never the stored credentials.


        **Notes.**

        - Only accounts at locations the caller can see. Credentials are never returned.'
      x-brix-permission: integration.view
      x-brix-schema: verified
      x-brix-notes:
      - Only accounts at locations the caller can see. Credentials are never returned.
      parameters:
      - name: provider
        in: query
        required: false
        schema:
          type: string
        description: Only accounts of this provider, e.g. `instagram`.
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        provider:
                          type: string
                          description: '`instagram`, `facebook`, `youtube`, `google-calendar`, `google-sheets`, …'
                        externalId:
                          type: string
                          description: The account's id at the provider.
                        displayName:
                          type: string
                        nodeId:
                          anyOf:
                          - type: string
                          - type: 'null'
                        expiresAt:
                          anyOf:
                          - type: string
                            description: ISO-8601 timestamp (UTC).
                          - type: 'null'
                          description: When the provider's access expires, if known.
                        needsReconnectAt:
                          anyOf:
                          - type: string
                            description: ISO-8601 timestamp (UTC).
                          - type: 'null'
                          description: 'Set when the provider refused the stored access: sign in again.'
                        createdAt:
                          type: string
                          description: ISO-8601 timestamp (UTC).
                        updatedAt:
                          type: string
                          description: ISO-8601 timestamp (UTC).
                      required:
                      - id
                      - provider
                      - externalId
                      - displayName
                      - nodeId
                      - expiresAt
                      - needsReconnectAt
                      - createdAt
                      - updatedAt
                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: createSocialAccount
      tags:
      - social-accounts
      summary: Add social account
      description: Create a social account connection by submitting its credentials directly. Credentials are encrypted before they are stored. For most providers, use the provider's OAuth start endpoint instead, since it handles sign-in and consent on your behalf.
      x-brix-permission: integration.create
      x-brix-schema: verified
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                provider:
                  type: string
                externalId:
                  type: string
                displayName:
                  type: string
                creds:
                  type: object
                  propertyNames:
                    type: string
                  additionalProperties: {}
                  description: The provider credential (for example access and refresh tokens). Encrypted; never returned.
                nodeId:
                  anyOf:
                  - type: string
                  - type: 'null'
                expiresAt:
                  anyOf:
                  - type: string
                  - type: 'null'
              required:
              - provider
              - externalId
              - displayName
              - creds
      responses:
        '200':
          description: 'Success: An account of the same provider and external id that needed a new sign-in was reconnected instead: its id is returned.'
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                    required:
                    - id
                required:
                - data
        '201':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: string
                    required:
                    - id
                required:
                - data
        '401':
          description: Missing, expired or revoked bearer token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: You do not hold `integration.create` at the location.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: '`provider`, `externalId`, `displayName` or `creds` is missing, or a location outside 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.create
  /v1/social-accounts/{id}:
    delete:
      operationId: deleteSocialAccount
      tags:
      - social-accounts
      summary: Remove social account
      description: 'Delete a connected social account by its ID. This permanently removes the stored credentials and stops any apps that use the account from fetching new data.


        **Notes.**

        - Answers `{ ok: true }`.'
      x-brix-permission: integration.delete
      x-brix-schema: verified
      x-brix-notes:
      - 'Answers `{ ok: true }`.'
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Social account id.
        example: soc_6f7a8b9c0d1e2f3a
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      ok:
                        type: boolean
                        const: true
                    required:
                    - ok
                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 account 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
    patch:
      operationId: updateSocialAccount
      tags:
      - social-accounts
      summary: Update social account
      description: 'Update a connected social account by its ID. You can change its display name or move it to a different location in your organization.


        **Notes.**

        - Answers `{ ok: true }`, not the account.'
      x-brix-permission: integration.edit
      x-brix-schema: verified
      x-brix-notes:
      - 'Answers `{ ok: true }`, not the account.'
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
        description: Social account id.
        example: soc_6f7a8b9c0d1e2f3a
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                displayName:
                  type: string
                nodeId:
                  description: Move the account; you need `integration.edit` at the destination too.
                  anyOf:
                  - type: string
                  - type: 'null'
                creds:
                  description: Replaces the stored credential and clears `needsReconnectAt`.
                  type: object
                  propertyNames:
                    type: string
                  additionalProperties: {}
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      ok:
                        type: boolean
                        const: true
                    required:
                    - ok
                required:
                - data
        '401':
          description: Missing, expired or revoked bearer token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: You cannot move the account to that location.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: No such account 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/social-accounts/preview-token:
    get:
      operationId: getSocialAccountPreviewToken
      tags:
      - social-accounts
      summary: Get social preview token
      description: Get a short-lived token used to preview a live social app before it is published to a screen. Pass this token as the dt query parameter when calling social feed endpoints from a preview. The token is issued only for your own workspace and cannot be requested for another one.
      x-brix-permission: integration.view
      x-brix-schema: verified
      responses:
        '200':
          description: Success.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      token:
                        type: string
                        description: A new short-lived token that lets an app preview read this workspace's social feeds (the `dt` parameter). Minted on each call.
                      expiresIn:
                        type: integer
                        description: Seconds until it expires (1800).
                    required:
                    - token
                    - expiresIn
                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
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.