Operator

Every organization of this brand, paginated; filters: plan, the Free period, suspended, over a limit, Free teams running forbidden site classes (filtered over the newest 2000; scanned/truncated say so)

get/operator/organizations

Request

  • Base URL: https://hostingsurge.com/api/v1
  • URL: https://hostingsurge.com/api/v1/operator/organizations
  • Auth: one of:
    • HTTP bearer
    • API key in cookie __Host-hs_session

Query parameters

limitinteger
offsetinteger nullable
searchstring
plan'free' | 'pro' | 'business' | 'unlimited'

the plan that applies (a grant included); unlimited: PLATFORM_UNLIMITED_ORG_IDS

trial'active' | 'ending' | 'ended' | 'paused' | 'site_cap' | 'exempt'

Free teams in this state of the Free period

suspended'true' | 'false'
overLimit'true'

more sites live than the plan's site cap, or more projects than its project limit

forbiddenKinds'true'

Free teams with a project of a class the Free plan does not host (WordPress, one-click apps, apps); databases are not checked

Response

Organizations

totalinteger required
limitinteger required
offsetinteger required
scannedinteger

rows the filter looked at (newest first); absent without a filter

truncatedboolean

true: there are more rows than the filter looked at; narrow the search

Changes

No recorded changes to this operation across all 1 revision of this API.