> ## Documentation Index > Fetch the complete documentation index at: https://docs.watchdog.no/llms.txt > Use this file to discover all available pages before exploring further. # 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. ## OpenAPI ````yaml /openapi-preview.json get /v1/overview openapi: 3.1.0 info: title: Watchdog API (preview) version: 1.0.0 description: >- Development preview for agreements, price items, document relationships, canonical invoices, alerts and alert topics, claims and attached alerts, shared entity activity and comments, Document uploads, invoice imports, explicit invoice-agreement matching, and workflow runs. This contract is under development and is not served by api.watchdog.no. Request bodies are limited to 2 MiB (2,097,152 bytes), including all JSON fields and line data, except POST /v1/support/contact which permits 32 MiB for base64 attachments. File bytes are uploaded directly to storage. The existing public REST service retains its separate contract. servers: - url: http://localhost:3500 description: Local development Worker security: [] paths: /v1/overview: get: tags: - Overview summary: Get the organization overview description: >- 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. operationId: getOverview parameters: - name: X-Organization-Id in: header required: false schema: type: string description: >- 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. responses: '200': description: Home metrics and next steps. headers: X-Request-Id: schema: type: string required: true description: >- Request identifier for support and diagnostics; also included in error bodies. Cache-Control: schema: type: string enum: - private, no-store required: false description: >- Organization-scoped API responses must not be cached. May be absent for requests rejected before routing. X-RateLimit-Limit: schema: type: string example: '120' required: false description: >- Requests per minute for the applicable limiter, when evaluated. Authenticated requests use the credential limit; an IP rejection uses the IP limit. content: application/json: schema: $ref: '#/components/schemas/Overview' example: 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 '400': description: >- 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). headers: X-Request-Id: schema: type: string required: true description: >- Request identifier for support and diagnostics; also included in error bodies. Cache-Control: schema: type: string enum: - private, no-store required: false description: >- Organization-scoped API responses must not be cached. May be absent for requests rejected before routing. X-RateLimit-Limit: schema: type: string example: '120' required: false description: >- Requests per minute for the applicable limiter, when evaluated. Authenticated requests use the credential limit; an IP rejection uses the IP limit. content: application/json: schema: $ref: '#/components/schemas/Error_validation_error' example: 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 '401': description: Missing or invalid bearer credential. headers: X-Request-Id: schema: type: string required: true description: >- Request identifier for support and diagnostics; also included in error bodies. Cache-Control: schema: type: string enum: - private, no-store required: false description: >- Organization-scoped API responses must not be cached. May be absent for requests rejected before routing. X-RateLimit-Limit: schema: type: string example: '120' required: false description: >- Requests per minute for the applicable limiter, when evaluated. Authenticated requests use the credential limit; an IP rejection uses the IP limit. WWW-Authenticate: schema: type: string required: false description: Bearer authentication challenge, when supplied. content: application/json: schema: $ref: '#/components/schemas/Error_invalid_token' example: error: code: invalid_token message: Missing or invalid bearer credential. request_id: req_example '403': description: >- Access denied: forbidden, token_disabled, organization_required, insufficient_role, or mfa_required. Check the error code and effective permissions. headers: X-Request-Id: schema: type: string required: true description: >- Request identifier for support and diagnostics; also included in error bodies. Cache-Control: schema: type: string enum: - private, no-store required: false description: >- Organization-scoped API responses must not be cached. May be absent for requests rejected before routing. X-RateLimit-Limit: schema: type: string example: '120' required: false description: >- Requests per minute for the applicable limiter, when evaluated. Authenticated requests use the credential limit; an IP rejection uses the IP limit. content: application/json: schema: $ref: >- #/components/schemas/Error_forbidden_token_disabled_organization_required_insufficient_role_mfa_required 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 '429': description: The IP or authenticated credential exceeded its request limit. headers: X-Request-Id: schema: type: string required: true description: >- Request identifier for support and diagnostics; also included in error bodies. Cache-Control: schema: type: string enum: - private, no-store required: false description: >- Organization-scoped API responses must not be cached. May be absent for requests rejected before routing. X-RateLimit-Limit: schema: type: string example: '120' required: false description: >- Requests per minute for the applicable limiter, when evaluated. Authenticated requests use the credential limit; an IP rejection uses the IP limit. Retry-After: schema: type: string example: '60' required: true description: Seconds to wait before retrying the request. content: application/json: schema: $ref: '#/components/schemas/Error_rate_limit_exceeded' example: error: code: rate_limit_exceeded message: >- The IP or authenticated credential exceeded its request limit. request_id: req_example '500': description: >- Unexpected server failure. Include the request ID when contacting support. headers: X-Request-Id: schema: type: string required: true description: >- Request identifier for support and diagnostics; also included in error bodies. Cache-Control: schema: type: string enum: - private, no-store required: false description: >- Organization-scoped API responses must not be cached. May be absent for requests rejected before routing. X-RateLimit-Limit: schema: type: string example: '120' required: false description: >- Requests per minute for the applicable limiter, when evaluated. Authenticated requests use the credential limit; an IP rejection uses the IP limit. content: application/json: schema: $ref: '#/components/schemas/Error_internal_error' example: error: code: internal_error message: >- Unexpected server failure. Include the request ID when contacting support. request_id: req_example '503': description: >- Authentication infrastructure is unavailable or rate limited. Honor Retry-After when provided. headers: X-Request-Id: schema: type: string required: true description: >- Request identifier for support and diagnostics; also included in error bodies. Cache-Control: schema: type: string enum: - private, no-store required: false description: >- Organization-scoped API responses must not be cached. May be absent for requests rejected before routing. X-RateLimit-Limit: schema: type: string example: '120' required: false description: >- Requests per minute for the applicable limiter, when evaluated. Authenticated requests use the credential limit; an IP rejection uses the IP limit. Retry-After: schema: type: string example: '60' required: true description: Seconds to wait before retrying the request. content: application/json: schema: $ref: '#/components/schemas/Error_service_unavailable' example: error: code: service_unavailable message: >- Authentication infrastructure is unavailable or rate limited. Honor Retry-After when provided. request_id: req_example security: - ApiKeyBearer: [] - ClerkSessionBearer: [] components: schemas: Overview: type: object properties: as_of: type: string format: date-time timezone: type: string organization_currency: type: string periods: type: object properties: coverage: type: object properties: start: type: string pattern: ^\d{4}-\d{2}-\d{2}$ end: type: string pattern: ^\d{4}-\d{2}-\d{2}$ required: - start - end recent: type: object properties: start: type: string pattern: ^\d{4}-\d{2}-\d{2}$ end: type: string pattern: ^\d{4}-\d{2}-\d{2}$ required: - start - end required: - coverage - recent agreement_count: type: integer minimum: 0 has_invoices: type: boolean invoice_spend: $ref: '#/components/schemas/OverviewMonetaryMetric' claims: type: object properties: awaiting: $ref: '#/components/schemas/OverviewMonetaryMetric' refunded: $ref: '#/components/schemas/OverviewMonetaryMetric' required: - awaiting - refunded alerts: type: object properties: pending: type: object properties: count: type: integer minimum: 0 value: $ref: '#/components/schemas/OverviewMonetaryMetric' required: - count - value required: - pending next_steps: type: array items: $ref: '#/components/schemas/OverviewNextStep' description: >- Applicable actions in priority order, each with its own display counts and target. required: - as_of - timezone - organization_currency - periods - agreement_count - has_invoices - invoice_spend - claims - alerts - next_steps Error_validation_error: type: object properties: error: type: object properties: code: type: string enum: - validation_error message: type: string request_id: type: string description: type: string details: type: array items: type: object properties: code: type: string field: type: string message: type: string required: - code - field - message maxItems: 20 workflow_run_id: type: string format: uuid import_id: type: string format: uuid existing_party: type: object properties: type: type: string enum: - supplier - recipient id: type: string format: uuid required: - type - id required: - code - message - request_id required: - error Error_invalid_token: type: object properties: error: type: object properties: code: type: string enum: - invalid_token message: type: string request_id: type: string description: type: string details: type: array items: type: object properties: code: type: string field: type: string message: type: string required: - code - field - message maxItems: 20 workflow_run_id: type: string format: uuid import_id: type: string format: uuid existing_party: type: object properties: type: type: string enum: - supplier - recipient id: type: string format: uuid required: - type - id required: - code - message - request_id required: - error Error_forbidden_token_disabled_organization_required_insufficient_role_mfa_required: type: object properties: error: type: object properties: code: type: string enum: - forbidden - token_disabled - organization_required - insufficient_role - mfa_required message: type: string request_id: type: string description: type: string details: type: array items: type: object properties: code: type: string field: type: string message: type: string required: - code - field - message maxItems: 20 workflow_run_id: type: string format: uuid import_id: type: string format: uuid existing_party: type: object properties: type: type: string enum: - supplier - recipient id: type: string format: uuid required: - type - id required: - code - message - request_id required: - error Error_rate_limit_exceeded: type: object properties: error: type: object properties: code: type: string enum: - rate_limit_exceeded message: type: string request_id: type: string description: type: string details: type: array items: type: object properties: code: type: string field: type: string message: type: string required: - code - field - message maxItems: 20 workflow_run_id: type: string format: uuid import_id: type: string format: uuid existing_party: type: object properties: type: type: string enum: - supplier - recipient id: type: string format: uuid required: - type - id required: - code - message - request_id required: - error Error_internal_error: type: object properties: error: type: object properties: code: type: string enum: - internal_error message: type: string request_id: type: string description: type: string details: type: array items: type: object properties: code: type: string field: type: string message: type: string required: - code - field - message maxItems: 20 workflow_run_id: type: string format: uuid import_id: type: string format: uuid existing_party: type: object properties: type: type: string enum: - supplier - recipient id: type: string format: uuid required: - type - id required: - code - message - request_id required: - error Error_service_unavailable: type: object properties: error: type: object properties: code: type: string enum: - service_unavailable message: type: string request_id: type: string description: type: string details: type: array items: type: object properties: code: type: string field: type: string message: type: string required: - code - field - message maxItems: 20 workflow_run_id: type: string format: uuid import_id: type: string format: uuid existing_party: type: object properties: type: type: string enum: - supplier - recipient id: type: string format: uuid required: - type - id required: - code - message - request_id required: - error OverviewMonetaryMetric: type: object properties: total: type: array items: type: object properties: currency_code: type: - string - 'null' amount: type: - string - 'null' pattern: ^-?\d+(?:\.\d+)?$ required: - currency_code - amount recent: type: array items: type: object properties: currency_code: type: - string - 'null' amount: type: - string - 'null' pattern: ^-?\d+(?:\.\d+)?$ required: - currency_code - amount description: Amounts for periods.recent. required: - total - recent OverviewNextStep: oneOf: - type: object properties: type: type: string enum: - add_invoices - add_agreement - upload_more_invoices required: - type - type: object properties: type: type: string enum: - review_alerts count: type: integer minimum: 0 exclusiveMinimum: 0 required: - type - count - type: object properties: type: type: string enum: - run_missing_checks count: type: integer minimum: 0 exclusiveMinimum: 0 required: - type - count - type: object properties: type: type: string enum: - finish_agreement - cancel_renewing_agreement - renew_agreement count: type: integer minimum: 0 exclusiveMinimum: 0 agreement_id: type: - string - 'null' format: uuid description: The target when count is one; otherwise null. required: - type - count - agreement_id - type: object properties: type: type: string enum: - add_supplier_agreements supplier_count: type: integer minimum: 0 exclusiveMinimum: 0 invoice_count: type: integer minimum: 0 coverage_ratio: type: number minimum: 0 maximum: 1 required: - type - supplier_count - invoice_count - coverage_ratio securitySchemes: ApiKeyBearer: type: http scheme: bearer description: >- Personal API key. Send X-Organization-Id. The required cumulative level is listed in x-watchdog-permission. ClerkSessionBearer: type: http scheme: bearer description: Clerk session with an active organization. ````