Skip to content

List metafield definition validation types

View as Markdown
get /rest/api/metafield_definition_validation_types

Retrieves the collection of MetafieldDefinitionValidationType resources.

Returns every metafield definition validation type - the valid values for a validation’s name.

Headers

NameTypeRequiredDescription
X-Flowkiwi-Organization-IdstringrequiredThe organization the request acts as. Determines the identity, permissions and ownership applied when reading or modifying data on the instance.

Response

200 - MetafieldDefinitionValidationType collection

PropertyTypeRequiredDescription
hydra:totalItemsinteger-
hydra:searchobject-
Show hydra:search fields
PropertyTypeRequiredDescription
@typestring-
hydra:templatestring-
hydra:variableRepresentationstring-
hydra:mappingobject[]-
Show hydra:mapping fields
PropertyTypeRequiredDescription
@typestring-
variablestring-
propertystring | null-
requiredboolean-
hydra:memberMetafieldDefinitionValidationType[]required
Show hydra:member fields
PropertyTypeRequiredDescription
@contextobject-
@idstringrequired
@typestringrequired
idstring-The validation type identifier (e.g. max_length).
descriptionstring-A human-readable description of the validation type.