Skip to main content
GET
Get workspace

Path Parameters

workspaceSlug
string
required

URL-safe 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.

memberRole
required

Role of the member in the workspace.

Allowed value: "owner"
settings
object
required

Workspace settings (approval requirement, data-retention rules).

slug
string
required

URL-safe workspace identifier.

Required string length: 3 - 32
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
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.