Skip to main content
Get the organization overview

Authorizations

Authorization
string
header
required

Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).

Headers

X-Organization-Id
string

The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.

Query Parameters

fields
string

Return only these fields, comma-separated; use dots for nested fields, such as periods.recent. Fields: as_of, timezone, organization_currency, periods, agreement_count, has_invoices, invoice_spend, claims, alerts, next_steps.

Response

Key figures 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.