Skip to main content
GET
Get workspace

Path Parameters

workspaceId
string<uuid>
required

Workspace identifier.

Response

Workspace response.

Workspace response.

createdAt
string<date-time>
required

Timestamp when the workspace was created.

createdBy
object
required

Account that created this workspace.

displayName
string
required

Display name of the workspace.

handle
string
required

URL-safe workspace handle. Display-only.

Required string length: 3 - 32
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
id
string<uuid>
required

Unique identifier of the workspace.

memberRole
required

Role of the member in the workspace.

Allowed value: "owner"
settings
object
required

Workspace settings (raster policy, data-retention rules, upload cap).

maxUploadBytes is resolved to the effective per-file limit — the smaller of the workspace's own cap and the server-wide hard limit — so a client always reads a concrete number to enforce.

updatedAt
string<date-time>
required

Timestamp when the workspace was last updated.

avatarUrl
string

Serve path of the workspace's avatar (logo), when set.

description
string

Description of the workspace.