---
title: "Read the workspace, its owner, and the signed-in person's other workspaces."
method: GET
path: "/v1/workspaces/{workspaceId}"
---

# Read the workspace, its owner, and the signed-in person's other workspaces.

`GET /v1/workspaces/{workspaceId}`

## Request

- Base URL: `https://api.bangermail.com`
- URL: `https://api.bangermail.com/v1/workspaces/{workspaceId}`
- Auth: HTTP bearer

Any actor authorized for the workspace may read it. other_workspaces lists the signed-in person's other active memberships. An OAuth grant or an API key is authorized for this workspace only and learns nothing about the others, so its other_workspaces is empty and its response carries a note saying so. A static API key has no person behind it, so its owner_email is null.

## Response `200`

The workspace as the caller sees it.

- object
  - `data` WorkspaceDetails, required
    - `id` string, uuid, required
    - `name` string, required
    - `name_source` 'signup' | 'brand' | 'user', required: Where the workspace name came from: signup (automatic sign-up name), brand (the company or brand confirmed in onboarding), or user (typed by a person; brand confirmations no longer rename it).
    - `role` 'owner' | 'admin' | 'member' | 'viewer' | 'partner', required
    - `owner_email` string, nullable, required
    - `avatar_url` string, nullable, required
    - `other_workspaces` object[], required
      - `id` string, uuid, required
      - `name` string, required
      - `role` 'owner' | 'admin' | 'member' | 'viewer' | 'partner', required
    - `note` string: Present for API-key and OAuth callers, whose connection is authorized for this workspace only.

## Other responses

- `404`: The workspace does not exist or is not available to this actor.

---

[API](https://skmtc.dev/bangermail/apis/banger-api.md) · [All operations](https://skmtc.dev/bangermail/apis/banger-api/llms.txt) · [OpenAPI document](https://skmtc.dev/bangermail/apis/banger-api/revisions/0705eb6ef2bc?raw)