Skip to main content
GET
Get workspace
Requires the workspaces:read scope. You must be a member of the workspace.

Path parameters

string
required
The numeric workspace ID.

Response

number
required
Workspace identifier.
string
required
Workspace name.
string
required
URL-safe identifier.
string | null
Optional workspace description.
string | null
Icon identifier slug (e.g., "folder-1", "chart", "briefcase"). null if not set.
string | null
Brand color.
string | null
Cover image URL.
number
required
User ID of the workspace owner.
string
required
Your role: owner, admin, member, or viewer.
string
required
UTC ISO-8601 creation timestamp.