Connected apps API
Connected apps endpoints in the Brix REST API: 2 operations (GET, DELETE). Each lists its path, auth, required permission and a curl example.
View as Markdown · For AI agents: the full docs index is at /llms.txt
Base URL https://api.brixsignage.com. Send Authorization: Bearer $BRIX_API_KEY unless an operation says Auth: none or Auth: no API key. The Permission line names what the key must hold. See Authentication and scopes, Errors and rate limits and Pagination.
Every 4xx and 5xx response below returns this body:
| Field | Type | Description |
|---|---|---|
error | string | Machine-readable code: unauthorized, forbidden, not_found, validation_error, conflict, rate_limited, internal_error, … |
message | string | Human-readable explanation. Safe to show an operator. |
requestId | string | Present on 5xx: quote it to support. |
GET /v1/connected-apps
Returns the AI assistants and other MCP clients that people in this workspace connected with OAuth: the client, who connected it, its permissions, the location it is pinned to, and when it was last used. You see a connection only where you hold the permission to view API keys at its location.
Notes.
- Newest first. Only connections whose location the caller can see with api-key.view are listed.
curl "https://api.brixsignage.com/v1/connected-apps" \
-H "Authorization: Bearer $BRIX_API_KEY"Response 200: Success.
| Field | Type | Description |
|---|---|---|
data | array of object | |
data[].id | string | Connection id. |
data[].clientId | string | |
data[].clientName | string | The app's name, as it registered. |
data[].redirectHost | string | null | The host the app signs in through. |
data[].connectedBy | object | null | The person who approved it; null if they no longer exist. |
data[].permissions | "all" | array of string | |
data[].nodeId | string | null | The location the connection is limited to; null for the whole workspace. |
data[].lastUsedAt | string | null | |
data[].connectedAt | string | ISO-8601 timestamp (UTC). |
data[].recent | array of object | null | The connection's latest actions (up to 5), newest first. Null without audit-log.view. |
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.
DELETE /v1/connected-apps/{id}
Disconnects an app that was connected with OAuth. Its access stops immediately. You must hold the permission to delete API keys at the location the connection is pinned to. Notes. - Answers the same for a connection that was already revoked.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | yes | Connection id. |
curl -X DELETE "https://api.brixsignage.com/v1/connected-apps/{id}" \
-H "Authorization: Bearer $BRIX_API_KEY"Response 200: Success.
| Field | Type | Description |
|---|---|---|
data | object | |
data.id | string | |
data.revoked | true |
Response 401: Missing, expired or revoked bearer token.
Response 403: You do not hold api-key.delete where the connection is limited to.
Response 404: No such connection in this workspace.
Response 5XX: Server error. The body carries a requestId to quote to support.