Skip to content

ts workspace

Show and manage one workspace: its settings, its members' permissions, and its lifecycle.

Usage

text
ts workspace [<action>] <workspace> [<property> <value>] [--force]

Description

The workspace can be given as its ID (the short name in URLs, such as acme) or its GUID.

With no action, ts workspace <ws> prints a summary — ID, name, GUID, timestamps, and how many apps and channels it holds. Use ts workspaces to list them all.

Actions:

  • new <name> creates a workspace and reports the ID the server assigned.
  • set <ws> <property> <value> changes one setting.
  • delete <ws> removes it. This is a soft delete: the workspace stops appearing but its content is retained, and restore brings it back.
  • restore <ws> undoes a delete.
  • users <ws> and permissions <ws> list who has access and at what level.
  • grant <ws> <user> <level> and revoke <ws> <user> change access.

Settable properties are name, default-domain, documentation, chat-enabled, default-item-visibility, and logo-width. Permission levels are user, read-only-admin, and administrator.

Options

FlagDescriptionDefault/ValuesNotes
--force, -fDelete without confirming.Required when there is no terminal.

Examples

bash
# Summary
ts workspace acme

# Create one and give someone access
ts workspace new acme
ts workspace grant acme alice administrator

# Change a setting
ts workspace set acme documentation "Internal design tools"
ts workspace set acme chat-enabled true

# Who can see it
ts workspace users acme
ts workspace permissions acme

# Remove access
ts workspace revoke acme alice

# Retire it, then change your mind
ts workspace delete acme
ts workspace restore acme

# In a script, where there is no one to confirm
ts workspace delete acme --force

Output

text
ID:       acme
Name:     Acme Design
Guid:     9b336df2-2599-490b-99bc-e17f2bf50f66
Created:  2026-07-29T23:26:48.192Z
Updated:  2026-07-29T23:27:02.551Z
Apps:     12
Channels: 3

users and permissions emit JSON, so they pipe into jq.

Exit Codes

0 on success. -6 when the workspace or property does not exist. -5 when the account is not a Server Administrator. -1 when a confirmation is declined.