List the fields defined on an object.
const url = 'https://example.com/v1/metadata/example/objects/example/fields?moduleKey=null&objectKey=null';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://example.com/v1/metadata/example/objects/example/fields?moduleKey=null&objectKey=null' \ --header 'Authorization: Bearer <token>'Authorizations
Section titled “Authorizations”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters”Module key.
Object key.
Query Parameters
Section titled “Query Parameters”Filter fields by module key.
Filter fields by module key.
Filter fields by object key (requires module_key).
Filter fields by object key (requires module_key).
Responses
Section titled “ Responses ”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
Optional description.
Field identifier within the object.
Field kind: "scalar", "formula", "lookup", or "rollup".
Scalar type for scalar/formula/rollup fields.
Formula expression for formula fields.
Audience-structured usage guidance for an object or field.
Set on an object definition or on any authorable field kind. Both keys are independently optional, so an author can supply only the one that applies.
Distinct from description: description says what the object or
field is; guidance says how to use it. Synthesized fields (managed
lookups, RelatedRecords inverses, junction objects) carry no
Guidance of their own — the owning relationship’s description is
their meaning.
object
Prose addressed to whoever writes records: conventions, units, when to use this object or field versus another. Absent by default.
Prose addressed to whoever queries records: what filters and aggregates mean, pitfalls to avoid. Absent by default.
Whether the field is indexed.
Human-readable label.
Lookup target for lookup fields.
Module that owns the parent object.
Object that owns this field.
Whether the field is required (NOT NULL).
Rollup aggregate function for rollup fields.
Whether the field has a unique constraint.
Examplegenerated
[ { "description": "example", "fieldKey": "example", "fieldKind": "example", "fieldType": "example", "formula": "example", "guidance": { "authoring": "example", "querying": "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": [{"domain", "scope", "target", "code", "message"}, ...]}. domain (added #950 D9) names the subsystem that produced the entry (data, metadata, apply, git, auth, iam, hfx, or api for a transport-level failure with no domain error behind it) and is always present.
The top-level response body. Wraps a non-empty list of [ErrorEntry].
object
The error entries making up the envelope. Always non-empty.
One entry in the error envelope.
Carries a [Domain] naming the subsystem that produced it, 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
Machine-readable, stable, SCREAMING_SNAKE_CASE identifier.
Which subsystem produced this entry. Always serialized.
data::error::DataError – record CRUD, validation, queries.
server::routes::metadata::error::MetadataError – the metadata
write API (module/object/field/screen PUT and POST).
server::apply::ApplyError – the metadata apply/plan pipeline.
server::git::GitError – the git-backed metadata repository.
auth::error::AuthError – JWT and credential authentication.
server::routes::iam::error::IamError – principal and credential
management (IAM handlers still emit Domain::Data for genuine
request-body field validation, which stays DataError).
server::routes::hfx::error::HfxError – HFX parse/emit.
Module packages (.hfmod, #1165): package format, signature and
compatibility refusals, and the install lifecycle that consumes them.
A transport-level ApiError built directly (forbidden,
not_found, internal, service_unavailable), with no
<Domain>Error behind it.
HFX source location for an HFX_PARSE entry.
Emitted as the extra location field on the entry JSON when present.
The line/column are 1-based. The frame is the offending source line
extracted verbatim from the input.
object
1-based column within the line, measured in UTF-16 code units of the prefix so browser-side editors can consume it directly.
The offending source line text, when available.
1-based line number within the source text.
Server-authored English message. Not part of the API contract; may change across releases without notice.
The key of the validation rule 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).
Field key for field scope, record id for record scope, null
otherwise. Always serialized, even when null.
Example
{ "errors": [ { "domain": "data", "scope": "field" } ]}