---
title: "Get the workspace"
method: GET
path: "/v1/workspace"
tags: ["workspace"]
---

# Get the workspace

`GET /v1/workspace`

## Request

- Base URL: `https://api.brixsignage.com`
- URL: `https://api.brixsignage.com/v1/workspace`
- Auth: HTTP bearer

Returns the calling workspace's id and name.

## Response `200`

Success.

- object
  - `data` WorkspaceRef, required
    - `id` string, required: Workspace id.
    - `name` string, nullable, required: Workspace name; null only if the workspace row is missing.

## Other responses

- `401`: Missing, expired or revoked bearer token.
- `403`: The token lacks the permission this operation needs (see `x-brix-permission`).
- `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)