Skip to content

Retrieve a metafield definition type

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

Retrieves a MetafieldDefinitionType resource.

Returns a single metafield definition type by id, including its allowedValidations.

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
idstringrequiredMetafieldDefinitionType identifier

Response

200 - MetafieldDefinitionType resource

PropertyTypeRequiredDescription
@contextobject-
@idstringrequired
@typestringrequired
idstring-The metafield definition type identifier (e.g. number_decimal).
descriptionstring-A human-readable description of the metafield definition type.
examplestring | null-An example value for a metafield of this type.
allowedValidationsstring[]-The validation types that can be applied to a metafield definition of this type. Submitting any other validation is rejected. 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