Skip to content

List metafield definition constraint types

View as Markdown
get /rest/api/metafield_definition_constraint_types

Retrieves the collection of MetafieldDefinitionConstraintType resources.

Returns every metafield definition constraint type.

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 - MetafieldDefinitionConstraintType 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:memberMetafieldDefinitionConstraintType[]required
Show hydra:member fields
PropertyTypeRequiredDescription
@contextobject-
@idstringrequired
@typestringrequired
idstring-The constraint type identifier (e.g. category).
descriptionstring-A human-readable description of the constraint type.