All report definitions. Empty in skeleton mode — "no templates" is the truth when there is no database, and the builder renders its empty state rather than an error.

GET

/api/v1/reports/definitions

curl --request GET \
  --url https://example.com/api/v1/reports/definitions \
  --header 'Authorization: Bearer <token>'

Authorizations

• bearer

Responses

200

Every report definition; empty in skeleton mode

Media typeapplication/json

Array<object>

A report definition (reusable template), as served to the API.

object

created_ms

required

integer format: int64

description

string | null

id

required

string format: uuid

name

required

string

spec

required

updated_by

string | null

updated_ms

required

integer format: int64

Example^generated

[
  {
    "created_ms": 1,
    "description": "example",
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "name": "example",
    "spec": "example",
    "updated_by": "example",
    "updated_ms": 1
  }
]

401

No valid bearer token

Media typeapplication/json

The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies undescribed — a client that has to guess the failure shape ends up parsing the success shape and reading undefined.

object

error

required

object

code

required

Stable machine-readable code. Clients branch on this, never on the message.

string

message

required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}

403

Role lacks View

Media typeapplication/json

The ADR-019 envelope every failure renders as. pub(crate) and schema-bearing so the OpenAPI document can name one error shape for every endpoint (ADR-035) instead of leaving 4xx/5xx bodies undescribed — a client that has to guess the failure shape ends up parsing the success shape and reading undefined.

object

error

required

object

code

required

Stable machine-readable code. Clients branch on this, never on the message.

string

message

required

Operator-facing sentence. Safe to display; never carries an internal error’s own text.

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example"
  }
}