Skip to content

List metafield owner types

View as Markdown
get /rest/api/metafield_owner_types

Retrieves the collection of MetafieldOwnerType resources.

Returns every metafield owner type, each with the allowedConstraints you may attach to a definition with that ownerType.

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 - MetafieldOwnerType 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:memberMetafieldOwnerType[]required
Show hydra:member fields
PropertyTypeRequiredDescription
@contextobject-
@idstringrequired
@typestringrequired
idstring-The metafield owner type identifier (e.g. products).
descriptionstring-A human-readable description of the metafield owner type.
allowedConstraintsstring[]-The constraint types that can be applied to a metafield definition whose ownerType is this owner type. Owner types that allow none return an empty array.