Skip to content
Henceforth Docs

List every field across all objects (transitional cross-module aggregation read).

GET
/metadata/-/fields
curl --request GET \
  --url https://example.com/metadata/-/fields \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json
Array<object>

Row from metadata.field.

pub(crate), not pub(super): named directly in crate::routes::metadata::mod::read_router’s .response::<200, ...>() OpenAPI response documentation (#814), which sits outside handlers.

object
fieldKey
required

Field identifier within the object.

string
fieldKind
required

Field kind: "scalar", "formula", "lookup", or "rollup".

string
fieldType

Scalar type for scalar/formula/rollup fields.

string | null
formula

Formula expression for formula fields.

string | null
indexed
required

Whether the field is indexed.

boolean
label
required

Human-readable label.

string
lookupTarget

Lookup target for lookup fields.

string | null
moduleKey
required

Module that owns the parent object.

string
objectKey
required

Object that owns this field.

string
required
required

Whether the field is required (NOT NULL).

boolean
rollupFunction

Rollup aggregate function for rollup fields.

string | null
uniqueConstraint
required

Whether the field has a unique constraint.

boolean
Examplegenerated
[
  {
    "fieldKey": "example",
    "fieldKind": "example",
    "fieldType": "example",
    "formula": "example",
    "indexed": true,
    "label": "example",
    "lookupTarget": "example",
    "moduleKey": "example",
    "objectKey": "example",
    "required": true,
    "rollupFunction": "example",
    "uniqueConstraint": true
  }
]

default

Section titled “default”

Structured error envelope (SPEC-DATA-0006): {"errors": [{"scope", "target", "code", "message"}, ...]}.

Media typeapplication/json

The top-level response body. Wraps a non-empty list of [ErrorEntry].

object
errors
required

The error entries making up the envelope. Always non-empty.

Array<object>

One entry in the error envelope.

Carries an anchoring [ErrorScope], an optional target that disambiguates within the scope, a stable SCREAMING_SNAKE_CASE code, and a human-readable English message. See SPEC-DATA-0006 for the full envelope contract.

object
code
required

Machine-readable, stable, SCREAMING_SNAKE_CASE identifier.

string
location
Any of:

HFX source location for a [DataError::HfxCompileError] entry.

Emitted as the extra location field on the entry JSON when present, per SPEC-UI-0043. The line/column are 1-based. The frame is the offending source line extracted verbatim from the input.

object
column
required

1-based column within the line, measured in UTF-16 code units of the prefix so browser-side editors can consume it directly.

integer format: uint32
frame

The offending source line text, when available.

string | null
line
required

1-based line number within the source text.

integer format: uint32
message
required

Server-authored English message. Not part of the API contract; may change across releases without notice.

string
rule

The key of the ValidationRule that failed, when the code is RULE_FAILED. None for all other codes.

Skipped during serialization when absent so it does not appear on unrelated entries (same pattern as location).

Documented here as a plain string (#[schemars(with = "...")]) rather than a $ref to ValidationRuleKey’s own schema: that type lives in metadata-types, which does not derive JsonSchema yet (tracked by #812). ValidationRuleKey serializes transparently as its inner string (serde’s default newtype-struct behavior), so this is an accurate wire-shape description, not a placeholder.

string | null
scope
required

Anchoring category. Drives client-side rendering.

One of:

Attached to a specific request field. target is the field key.

string
Allowed value: field
target

Field key for field scope, record id for record scope, null otherwise. Always serialized, even when null.

string | null
Example
{
  "errors": [
    {
      "scope": "field"
    }
  ]
}