Skip to main content
GET
Get the Agency workspace

Authorizations

Authorization
string
header
required

Your API key (prv_...), sent as Authorization: Bearer prv_.... It is the only credential the API needs - see the Authentication guide. The older x-preuve-key header still works for existing integrations.

Query Parameters

limit
integer
default:20

Client reports to return in the reports array.

Required range: 1 <= x <= 50
offset
integer
default:0

Paging offset into the reports array.

Required range: 0 <= x <= 10000

Response

Workspace, role, quota, and one page of client reports.

agency
object
quota
object

Shared project quota for the workspace, same pool as the dashboard.

canRunScan
boolean

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.

canRunStarterScan
boolean

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.

reports
object[]

One page of the workspace's client reports, newest first, including ones created in the Agency dashboard. Same shape and paging as /api/agent/agency/reports.

nextOffset
integer | null

Offset of the next page of reports, or null on the last page.