---
title: "Get support access status"
method: GET
path: "/v1/account/support-access"
tags: ["account"]
---

# Get support access status

`GET /v1/account/support-access`

## Request

- Base URL: `https://api.brixsignage.com`
- URL: `https://api.brixsignage.com/v1/account/support-access`
- Auth: HTTP bearer

Returns the workspace's current Brix support access policy (always allowed, allowed with notification, or approval required), every access request Brix support has raised along with its decision, and every support session opened on the workspace, with any still in progress marked as live.

**Notes.**
- A read that can write: pending requests past their expiry are marked `expired` first.

## Response `200`

Success.

- object
  - `data` object, required
    - `policy` SupportAccessPolicy, required
      - `mode` 'open' | 'notify' | 'approve', required: `open`: Brix support may open the workspace. `notify`: it may, and the owners are emailed. `approve`: a person here must approve each request.
      - `grantMinutes` integer, required: How long an approval lasts.
      - `requestTtlMinutes` integer, required: How long a request waits for an answer before it expires.
    - `modes` object[], required
      - `id` 'open' | 'notify' | 'approve', required
      - `label` string, required
      - `what` string, required
    - `requests` object[], required: Newest 100.
      - `id` string, required
      - `staffEmail` string, required: The Brix support person who asked.
      - `reason` string, required
      - `reasonCategory` string, nullable, required
      - `status` 'pending' | 'approved' | 'denied' | 'expired' | 'revoked', required
      - `requestedAt` string, required: ISO-8601 timestamp (UTC).
      - `requestExpiresAt` string, required: ISO-8601 timestamp (UTC).
      - `decidedAt` string, nullable, required: ISO-8601 timestamp (UTC).
      - `decidedByEmail` string, nullable, required
      - `decidedByName` string, nullable, required
      - `grantExpiresAt` string, nullable, required: ISO-8601 timestamp (UTC).
      - `decisionNote` string, nullable, required
      - `grantLive` boolean, required
    - `sessions` object[], required: Times Brix support opened the workspace, newest 100.
      - `id` string, required
      - `staffEmail` string, required
      - `reason` string, required
      - `startedAt` string, required: ISO-8601 timestamp (UTC).
      - `endedAt` string, nullable, required: ISO-8601 timestamp (UTC).
      - `expiresAt` string, nullable, required: ISO-8601 timestamp (UTC).
      - `live` boolean, required
      - `recorded` boolean, required: The session was screen-recorded.

## Other responses

- `401`: Missing, expired or revoked bearer token.
- `403`: You do not hold the permission for the whole workspace (a grant at one location is not enough).
- `5XX`: Server error. The body carries a `requestId` to quote to support.

---

[API](https://skmtc.dev/brixsignage/apis/brix-api.md) · [All operations](https://skmtc.dev/brixsignage/apis/brix-api/llms.txt) · [OpenAPI document](https://skmtc.dev/brixsignage/apis/brix-api/revisions/02fd3665dc7d?raw)