---
title: "Get a workspace's preview URL."
method: GET
path: "/v0/workspaces/{workspaceId}/preview"
tags: ["Workspaces"]
---

# Get a workspace's preview URL.

`GET /v0/workspaces/{workspaceId}/preview`

## Request

- Base URL: `https://api.conductor.build` (the document declares no server; this is the origin it was published from)
- URL: `https://api.conductor.build/v0/workspaces/{workspaceId}/preview`
- Auth: HTTP bearer

Returns the shared port and its preview URL, or `preview: null` when no port is shared.

## Path parameters

- `workspaceId` string, required

## Response `200`

Default Response

- object
  - `preview` object, required
    - `port` number, required
    - `url` string, required

## Other responses

- `400`: Invalid request.
- `401`: Missing or invalid bearer token.
- `404`: Resource not found.
- `default`: Error response.

---

[API](https://skmtc.dev/conductor-build/apis/roundhouse-public-api.md) - [All operations](https://skmtc.dev/conductor-build/apis/roundhouse-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/conductor-build/apis/roundhouse-public-api/revisions/1f39c7f7f219?raw)
