Skip to main content
POST

Authorizations

Authorization
string
header
required

User PAT (cliq_tok_…, including session-scoped) or realm token (cliq_dt_…).

Body

application/json
daemon_id
string

Ask this daemon for its workspaces live, instead of reading CliqHub's catalog.

realm_id
string

Only workspaces on a daemon of this realm, or that ran a run in it

org_id
string<uuid>

Only workspaces on a daemon in a realm of this org, or that ran a run in the org (narrows what the caller may already see)

limit
integer

Page size (at most 200). Default all.

Required range: x >= 1
offset
integer

Rows to skip, for paging.

sort_by
enum<string>

Stored list only (400 with daemon_id, which asks the daemon live).

Available options:
name,
created_at
sort_dir
enum<string>

Sort direction with sort_by (default asc); ties are broken by id ascending

Available options:
asc,
desc

Response

Catalog: { workspaces, total, offset, limit }. With daemon_id: { data }, the daemon's answer ({ workspaces: [...] }).

ok
enum<boolean>
required

Always true on success.

Available options:
true
workspaces
object[]
total
integer
offset
integer
limit
integer
data
object

Only with daemon_id: the daemon's list (see the Daemon API, List workspaces).