Skip to main content
GET
Get workspace

Authorizations

Authorization
string
header
required

API key or session token (Bearer)

Path Parameters

workspaceId
string
required

Response

The workspace

id
string
required
name
string
required
slug
string
required
logo
string | null
required
description
string | null
required
createdAt
string<date-time>
required
role
string | null
required

The caller's workspace role: a built-in role (owner, admin, member, viewer) or the name of a custom role defined in the workspace. Several roles are comma-separated, for example owner,viewer. Null when an instance admin views a workspace they are not a member of.