Skip to main content
POST
List scopes

Authorizations

Authorization
string
header
required

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

Body

application/json
user_id
string<uuid>

User whose publish-access scopes to list; omit for full catalog (site admin only)

org_id
string<uuid>

Narrow results to scopes owned by this org

query
string

Substring match on slug or display_name

limit
integer

Maximum number of results to return (1–100)

Required range: 1 <= x <= 100
offset
integer

Zero-based offset for pagination

Required range: x >= 0
sort_by
enum<string>

Sort column: slug | visibility | team_count | created_at. Omit for the default order (a user's scopes by slug; the full catalog newest first).

Available options:
slug,
visibility,
team_count,
created_at
sort_dir
enum<string>

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

Available options:
asc,
desc

Response

{ items, total, offset, limit } for a user's scopes; { scopes, total, offset, limit } for the catalog.

ok
enum<boolean>
required

Always true on success.

Available options:
true
data
object
required