Skip to content

License Audit

Use this page to retrieve a license-centered reporting object for audit and support workflows.

Who This Is For

  • operators investigating a specific license
  • support teams reviewing a license’s state and history
  • teams preparing audit evidence for one license

When To Use This

Use license audit when the reporting question starts with one license and you want a consolidated reporting view rather than a set of separate API calls.

How It Works

GET /api/v1/reports/license-audit uses report:read.

Required query parameter:

  • license_id

Optional filters:

  • from
  • to
  • limit

Response shape:

  • data: a report-specific object
  • meta

Inference from the route purpose and the surrounding reporting design: this endpoint is intended to return a license-centered evidence package rather than a flat ledger row list. Treat the endpoint output itself as the canonical field-level contract for the report.

Use the read API when you need an interactive report view. Use exports when you need a frozen audit artifact.

Example

bash
curl "https://api.licensekit.dev/api/v1/reports/license-audit?license_id=lic_123&from=2026-01-01T00:00:00Z" \
  -H "Authorization: Bearer $LICENSEKIT_TOKEN"

Common Mistakes

  • expecting this route to behave like a generic list endpoint
  • using raw audit events alone when the actual question is license-centered
  • forgetting that license_id is required

Prototype docs shell for the rewrite workspace.