Skip to main content
POST
List organizations

Authorizations

Authorization
string
header
required

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

Body

application/json
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
mine
boolean

When true, return only orgs the caller is a member of (ignores admin privileges)

sort_by
enum<string>

Sort column: slug | display_name | member_count | scope_count | created_at. Omit for the default order (exact slug match first when searching, then newest first; site-admin list only — 400 with mine).

Available options:
slug,
display_name,
member_count,
scope_count,
created_at
sort_dir
enum<string>

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

Available options:
asc,
desc
status
enum<string>

Site-admin list only: only orgs in this state (deleted lists soft-deleted orgs)

Available options:
active,
waiting_for_owner,
deleted
include_deleted
boolean

Site-admin list only: also list soft-deleted orgs

Response

Success.

ok
enum<boolean>
required

Always true on success.

Available options:
true
data
object
required