List custom field definitions

GET /v1/custom-metadata-definitions

List custom field definitions

Definitions are reference data: the values editor on every detail page needs them to render the right input and to warn on near-miss keys, so reads are open to any store member. Authoring is gated on routing.manage.

Query Parameters

entityType optional

string

key optional

string

label optional

string

valueType optional

string

enumValues optional

string

unit optional

string

defaultValue optional

string

Written into a record's `customMetadata` when that record is created, so the field is on every new record of its type. This is the only way a definition puts itself on a record: a field with no value is not listed, because a row the record does not carry is a row that lies about it. Never applied to records that already exist.

defaultToNow optional

string

Date/time fields only, and the only default they can carry: the value is the moment the record was created. A fixed date is almost never the right default, and there is no way to express "now" as a literal.

id optional

string

storeId optional

string

createdAt optional

string

updatedAt optional

string

sort optional

string

limit optional

number

offset optional

number

fields optional

string

include optional

string

meta optional

boolean

hints optional

boolean

Response Schema

Response

value

object[] | object