curl -X GET 'https://<tenant>.product-management.flowkiwi.net/rest/api/metafield_definition_types' \ -H 'Authorization: Bearer {token}' \ -H 'X-Flowkiwi-Organization-Id: <org_id>' \ -H 'Accept: application/ld+json'

{ "@context": "/contexts/MetafieldDefinitionType", "@id": "/rest/api/metafield_definition_types", "@type": "hydra:Collection", "hydra:totalItems": 2, "hydra:member": [ { "@context": "/contexts/MetafieldDefinitionType", "@id": "/rest/api/metafield_definition_types/number_decimal", "@type": "https://schema.org/Enumeration", "id": "number_decimal", "description": "A number with decimal.", "example": 10.4, "allowedValidations": [ "/rest/api/metafield_definition_validation_types/min_value", "/rest/api/metafield_definition_validation_types/max_value", "/rest/api/metafield_definition_validation_types/max_precision" ] }, { "@context": "/contexts/MetafieldDefinitionType", "@id": "/rest/api/metafield_definition_types/json", "@type": "https://schema.org/Enumeration", "id": "json", "description": "A JSON-serializable value. This can be an object, an array, a string, a number, a boolean, or a null value.", "example": "{ \"ingredient\": \"flour\", \"amount\": 0.3 }", "allowedValidations": [ "/rest/api/metafield_definition_validation_types/json_schema" ] } ] }

List metafield definition types

View as Markdown

get /rest/api/metafield_definition_types

Retrieves the collection of MetafieldDefinitionType resources.

Returns every metafield definition type, each with the allowedValidations you may attach to a definition of that type.

Headers

Name	Type	Required	Description
`X-Flowkiwi-Organization-Id`	`string`	required	The organization the request acts as. Determines the identity, permissions and ownership applied when reading or modifying data on the instance.

Response

200 - MetafieldDefinitionType collection

Format

Property Type Required Description

hydra:totalItems integer -

hydra:search object -

Show hydra:search fields

Property Type Required Description

@type string -

hydra:template string -

hydra:variableRepresentation string -

hydra:mapping object[] -

Show hydra:mapping fields

Property	Type	Required
`@type`	`string`	-
`variable`	`string`	-
`property`	`string \| null`	-
`required`	`boolean`	-

hydra:member MetafieldDefinitionType[] required

Show hydra:member fields

Property	Type	Required	Description
`@context`	`object`	-
`@id`	`string`	required
`@type`	`string`	required
`id`	`string`	-	The metafield definition type identifier (e.g. `number_decimal`).
`description`	`string`	-	A human-readable description of the metafield definition type.
`example`	`string \| null`	-	An example value for a metafield of this type.
`allowedValidations`	`string[]`	-	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.