Skip to content

Retrieve a metafield owner type

View as Markdown
get /rest/api/metafield_owner_types/{id}

Retrieves a MetafieldOwnerType resource.

Returns a single metafield owner type by id, including its allowedConstraints.

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.

Path parameters

NameTypeRequiredDescription
idstringrequiredMetafieldOwnerType identifier

Response

200 - MetafieldOwnerType resource

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.

Errors

404 - Not found

PropertyTypeRequiredDescription
@contextobject-
@idstringrequired
@typestringrequired
titlestring | null-A short, human-readable summary of the problem.
detailstring | null-A human-readable explanation specific to this occurrence of the problem.
statusnumber | null-
instancestring | null-A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
typestring-A URI reference that identifies the problem type