Skip to main content
Get the organization overview

Authorizations

Authorization
string
header
required

Personal API key. Send X-Organization-Id. The required cumulative level is listed in x-watchdog-permission.

Headers

X-Organization-Id
string

Required for personal API keys. Target one organization you have access to. Migrated keys may omit it to use their original organization. For Clerk sessions, it must match the active organization.

Response

Home metrics and next steps.

as_of
string<date-time>
required
timezone
string
required
organization_currency
string
required
periods
object
required
agreement_count
integer
required
Required range: x >= 0
has_invoices
boolean
required
invoice_spend
object
required
claims
object
required
alerts
object
required
next_steps
object[]
required

Applicable actions in priority order, each with its own display counts and target.