Get the Agency workspace
Workspace identity, the caller’s role, remaining shared project quota, and one page of the workspace’s client reports - dashboard-created ones included, newest first, without report bodies. Consultant and AppSumo Agency accounts only: a key whose account holds no Agency workspace, or whose membership was removed, gets 404 AGENCY_NOT_FOUND on the next call. Membership is resolved live on every request, independently of the key.
Authorizations
Query Parameters
Response
Workspace, role, quota, and one page of client reports.
Eligibility, not live availability. True only when the role may run scans, the workspace is approved, billing setup is done, and quota remains. It does not read the service kill switch, the LLM pause or the rate limiters, so a start can still answer 503 or 429 while this is true. None of those refusals spends a project credit. This is the deep project slot answer only; see canRunStarterScan for a client Starter Scan.
Whether a client Starter Scan (scanType "starter", no project slot) can start for this key. Eligibility, like canRunScan. True only for the workspace owner who holds the AppSumo Tier 4 or 5 licence, or for the owner of a workspace nobody has funded while its one free scan is unused. It does not read the deep quota or payment setup, and it does not count the Starter fair use, so a start can still answer 429 FAIR_USE_LIMIT.