Data sources API

GET/v1/data-sources

List the data feeds, such as spreadsheets, APIs, and other connectors, that creatives and apps can connect to. Credentials are encrypted at rest and are never returned. **Notes.** - Not paginated: every data source you can see comes back in one response (no ?limit/?cursor, unlike the app instance, creative and layout lists).

curl "https://api.brixsignage.com/v1/data-sources" \
  -H "Authorization: Bearer $BRIX_API_KEY"

Response 200 Success.

Response 401 Missing, expired or revoked bearer token.

Response 403 The token lacks the permission this operation needs (see `x-brix-permission`).

Response 5XX Server error. The body carries a `requestId` to quote to support.

POST/v1/data-sources

Connect a data feed with a name, a connector type, a config, and an optional nodeId. Any credentials included in config are encrypted at rest. Test the configuration first with POST /v1/data-sources/test before creating it. **Notes.** - Gated by integration.edit, not integration.create.

Request body application/json

curl -X POST "https://api.brixsignage.com/v1/data-sources" \
  -H "Authorization: Bearer $BRIX_API_KEY" \
  -H "Content-Type: application/json"

Response 201 Success.

Response 401 Missing, expired or revoked bearer token.

Response 403 The token lacks the permission this operation needs (see `x-brix-permission`).

Response 422 `name` or `type` is missing, or `invalid_node`: the location is not in this workspace.

Response 5XX Server error. The body carries a `requestId` to quote to support.

GET/v1/data-sources/{id}

Retrieve one data source, including its connector configuration, the time of its last sync, and its row schema. Secret values are redacted.

curl "https://api.brixsignage.com/v1/data-sources/{id}" \
  -H "Authorization: Bearer $BRIX_API_KEY"

Response 200 Success.

Response 401 Missing, expired or revoked bearer token.

Response 403 The token lacks the permission this operation needs (see `x-brix-permission`).

Response 404 No such data source in this workspace.

Response 5XX Server error. The body carries a `requestId` to quote to support.

PATCH/v1/data-sources/{id}

Edit a data source's name, connector configuration, or node. Send •••••••• back for a credential to keep the stored value. To point the source at a different address or connector type, enter the credential again.

Request body application/json

curl -X PATCH "https://api.brixsignage.com/v1/data-sources/{id}" \
  -H "Authorization: Bearer $BRIX_API_KEY" \
  -H "Content-Type: application/json"

Response 200 Success.

Response 401 Missing, expired or revoked bearer token.

Response 403 No `integration.edit` at the destination location.

Response 404 No such data source in this workspace.

Response 422 `credential_reentry_required`: the change moves a masked credential to a new address or connector type (`fields` names what moved); or `invalid_node`: the destination is not in this workspace.

Response 5XX Server error. The body carries a `requestId` to quote to support.

DELETE/v1/data-sources/{id}

Delete a data source. It can be restored later with POST /v1/data-sources/:id/restore. Creatives connected to it display their fallback values while it is deleted.

curl -X DELETE "https://api.brixsignage.com/v1/data-sources/{id}" \
  -H "Authorization: Bearer $BRIX_API_KEY"

Response 200 Success.

Response 401 Missing, expired or revoked bearer token.

Response 403 The token lacks the permission this operation needs (see `x-brix-permission`).

Response 404 No such data source in this workspace.

Response 5XX Server error. The body carries a `requestId` to quote to support.

POST/v1/data-sources/{id}/restore

Restore a deleted data source connector. Apps and creatives connected to it begin receiving fresh data again the next time their content refreshes.

curl -X POST "https://api.brixsignage.com/v1/data-sources/{id}/restore" \
  -H "Authorization: Bearer $BRIX_API_KEY"

Response 200 Success.

Response 401 Missing, expired or revoked bearer token.

Response 403 The token lacks the permission this operation needs (see `x-brix-permission`).

Response 404 No such data source in this workspace.

Response 409 `not_deleted`: the data source is not in the recycle bin.

Response 5XX Server error. The body carries a `requestId` to quote to support.

POST/v1/data-sources/{id}/sync

Pull fresh data for one data source immediately instead of waiting for its regular schedule. Runs the connector once and caches the result. A connector failure is NOT an HTTP error: the answer is 200 with synced: false and the reason.

curl -X POST "https://api.brixsignage.com/v1/data-sources/{id}/sync" \
  -H "Authorization: Bearer $BRIX_API_KEY"

Response 200 Success.

Response 401 Missing, expired or revoked bearer token.

Response 403 The token lacks the permission this operation needs (see `x-brix-permission`).

Response 404 No such data source in this workspace.

Response 5XX Server error. The body carries a `requestId` to quote to support.

POST/v1/data-sources/refresh-all

Pull fresh data for every data source in the workspace immediately. This action is rate-limited to 5 requests per minute. Syncs, one after another, every data source the caller may edit. Rate limited to 5 calls a minute.

curl -X POST "https://api.brixsignage.com/v1/data-sources/refresh-all" \
  -H "Authorization: Bearer $BRIX_API_KEY"

Response 200 Success.

Response 401 Missing, expired or revoked bearer token.

Response 403 The token lacks the permission this operation needs (see `x-brix-permission`).

Response 429 More than 5 calls in a minute.

Response 5XX Server error. The body carries a `requestId` to quote to support.

GET/v1/data-sources/sheets-methods

List the ways a Google Sheet can be shared with the platform, and the address to share it with. The response may include publicLink, serviceAccount, and oauth, depending on what the platform supports; a method is listed only if it is actually available. serviceAccount is not a secret; it is the address you enter into Google's Share dialog.

curl "https://api.brixsignage.com/v1/data-sources/sheets-methods" \
  -H "Authorization: Bearer $BRIX_API_KEY"

Response 200 Success.

Response 401 Missing, expired or revoked bearer token.

Response 403 The token lacks the permission this operation needs (see `x-brix-permission`).

Response 5XX Server error. The body carries a `requestId` to quote to support.

POST/v1/data-sources/test

Validate a connector configuration without saving it. Returns { ok: true, preview } on success or { ok: false, error } on failure, so a misconfigured feed can be caught before it is created. Runs the connector once with a config that is not saved. A connector failure is NOT an HTTP error: the answer is 200 with ok: false and the reason. Rate limited to 20 calls a minute.

Request body application/json

curl -X POST "https://api.brixsignage.com/v1/data-sources/test" \
  -H "Authorization: Bearer $BRIX_API_KEY" \
  -H "Content-Type: application/json"

Response 200 Success.

Response 401 Missing, expired or revoked bearer token.

Response 403 The token lacks the permission this operation needs (see `x-brix-permission`).

Response 429 More than 20 calls in a minute.

Response 5XX Server error. The body carries a `requestId` to quote to support.