curl --request GET \
--url http://localhost:3500/v1/overview \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:3500/v1/overview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "http://localhost:3500/v1/overview"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"as_of": "2026-09-18T12:00:00.000Z",
"timezone": "Europe/Oslo",
"organization_currency": "NOK",
"periods": {
"coverage": {
"start": "2025-09-18",
"end": "2026-09-18"
},
"recent": {
"start": "2026-09-12",
"end": "2026-09-18"
}
},
"agreement_count": 8,
"has_invoices": true,
"invoice_spend": {
"total": [
{
"currency_code": "NOK",
"amount": "250000.00"
}
],
"recent": [
{
"currency_code": "NOK",
"amount": "12000.00"
}
]
},
"claims": {
"awaiting": {
"total": [
{
"currency_code": "NOK",
"amount": "4000.00"
}
],
"recent": [
{
"currency_code": "NOK",
"amount": "1000.00"
}
]
},
"refunded": {
"total": [
{
"currency_code": "NOK",
"amount": "2000.00"
}
],
"recent": [
{
"currency_code": "NOK",
"amount": "500.00"
}
]
}
},
"alerts": {
"pending": {
"count": 4,
"value": {
"total": [
{
"currency_code": "NOK",
"amount": "3000.00"
}
],
"recent": [
{
"currency_code": "NOK",
"amount": "750.00"
}
]
}
}
},
"next_steps": [
{
"type": "review_alerts",
"count": 4
},
{
"type": "finish_agreement",
"count": 1,
"agreement_id": "00000000-0000-4000-8000-000000000001"
}
]
}{
"error": {
"code": "validation_error",
"message": "Invalid request format, parameters, or body. Details contain up to 20 actionable field errors; the complete encoded request body must be at most 2 MiB (2,097,152 bytes).",
"request_id": "req_example"
}
}{
"error": {
"code": "invalid_token",
"message": "Missing or invalid bearer credential.",
"request_id": "req_example"
}
}{
"error": {
"code": "forbidden",
"message": "Access denied: forbidden, token_disabled, organization_required, insufficient_role, or mfa_required. Check the error code and effective permissions.",
"request_id": "req_example"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "The IP or authenticated credential exceeded its request limit.",
"request_id": "req_example"
}
}{
"error": {
"code": "internal_error",
"message": "Unexpected server failure. Include the request ID when contacting support.",
"request_id": "req_example"
}
}{
"error": {
"code": "service_unavailable",
"message": "Authentication infrastructure is unavailable or rate limited. Honor Retry-After when provided.",
"request_id": "req_example"
}
}Get the organization overview
Organization-wide Home summary and ordered next-step objects. Each step carries its own display counts and, for agreement actions, a singular agreement_id or null for list navigation. Setup and upload steps carry only type. Lifetime invoice spend is excluding VAT, including credit notes and future-dated invoices. Recent means the organization-local last seven calendar days including today; coverage uses trailing twelve months. Coverage is the fraction of checkable invoices matched to a ready agreement, not completed-check coverage. Money is returned as exact decimal strings; incomplete amounts remain null. Unchecked counts distinct checkable invoices with a primary document and at least one ready matched agreement without a completed or active check. Active checks include API invoice and agreement checks and legacy missing-check runs; POST /v1/agreements/check checks the unchecked invoices. as_of is the calculation time, not a retained database snapshot. This read does not initiate work.
curl --request GET \
--url http://localhost:3500/v1/overview \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:3500/v1/overview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "http://localhost:3500/v1/overview"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"as_of": "2026-09-18T12:00:00.000Z",
"timezone": "Europe/Oslo",
"organization_currency": "NOK",
"periods": {
"coverage": {
"start": "2025-09-18",
"end": "2026-09-18"
},
"recent": {
"start": "2026-09-12",
"end": "2026-09-18"
}
},
"agreement_count": 8,
"has_invoices": true,
"invoice_spend": {
"total": [
{
"currency_code": "NOK",
"amount": "250000.00"
}
],
"recent": [
{
"currency_code": "NOK",
"amount": "12000.00"
}
]
},
"claims": {
"awaiting": {
"total": [
{
"currency_code": "NOK",
"amount": "4000.00"
}
],
"recent": [
{
"currency_code": "NOK",
"amount": "1000.00"
}
]
},
"refunded": {
"total": [
{
"currency_code": "NOK",
"amount": "2000.00"
}
],
"recent": [
{
"currency_code": "NOK",
"amount": "500.00"
}
]
}
},
"alerts": {
"pending": {
"count": 4,
"value": {
"total": [
{
"currency_code": "NOK",
"amount": "3000.00"
}
],
"recent": [
{
"currency_code": "NOK",
"amount": "750.00"
}
]
}
}
},
"next_steps": [
{
"type": "review_alerts",
"count": 4
},
{
"type": "finish_agreement",
"count": 1,
"agreement_id": "00000000-0000-4000-8000-000000000001"
}
]
}{
"error": {
"code": "validation_error",
"message": "Invalid request format, parameters, or body. Details contain up to 20 actionable field errors; the complete encoded request body must be at most 2 MiB (2,097,152 bytes).",
"request_id": "req_example"
}
}{
"error": {
"code": "invalid_token",
"message": "Missing or invalid bearer credential.",
"request_id": "req_example"
}
}{
"error": {
"code": "forbidden",
"message": "Access denied: forbidden, token_disabled, organization_required, insufficient_role, or mfa_required. Check the error code and effective permissions.",
"request_id": "req_example"
}
}{
"error": {
"code": "rate_limit_exceeded",
"message": "The IP or authenticated credential exceeded its request limit.",
"request_id": "req_example"
}
}{
"error": {
"code": "internal_error",
"message": "Unexpected server failure. Include the request ID when contacting support.",
"request_id": "req_example"
}
}{
"error": {
"code": "service_unavailable",
"message": "Authentication infrastructure is unavailable or rate limited. Honor Retry-After when provided.",
"request_id": "req_example"
}
}Authorizations
Personal API key. Send X-Organization-Id. The required cumulative level is listed in x-watchdog-permission.
Headers
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.
Show child attributes
Show child attributes
x >= 0Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Applicable actions in priority order, each with its own display counts and target.
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
Show child attributes
Show child attributes