curl -X GET 'https://<tenant>.product-management.flowkiwi.net/api/{ownerResource}/{ownerId}/metafields' \ -H 'Authorization: Bearer {access_token}' \ -H 'Flowkiwi-Api-Version: unstable' \ -H 'Accept: application/ld+json'

{ "@context": "/api/contexts/Metafield", "@id": "/api/products/019af93e-420e-79f8-800b-6680f03dce20/metafields", "@type": "Collection", "member": [ { "@context": "/api/contexts/Metafield", "@id": "/api/products/019af93e-420e-79f8-800b-6680f03dce20/metafields/019afb02-2b3c-7d4e-9f50-1a2b3c4d5e6f", "@type": "Metafield", "createdAt": "2026-01-15T09:30:00+00:00", "definition": "/api/metafield_definitions/019afb01-1a2b-7c3d-8e4f-0a1b2c3d4e5f", "id": "019afb02-2b3c-7d4e-9f50-1a2b3c4d5e6f", "metaobject": [], "ownerId": "019af93e-420e-79f8-800b-6680f03dce20", "ownerResource": "products", "updatedAt": "2026-02-03T14:45:12+00:00", "value": "Machine wash cold at 30°C" } ], "totalItems": 1 }

List metafields

View as Markdown

get /api/{ownerResource}/{ownerId}/metafields

Retrieves the collection of Metafield resources.

Returns the metafields stored on a single owner record, identified by ownerResource (such as products) and ownerId. Set Flowkiwi-Locale to read translatable values in a given locale.

Headers

Name	Type	Required	Description
`Flowkiwi-Locale`	`string`	-	Specifies the locale for properties that support localization. If not provided, the default locale will be used.

Path parameters

Name	Type	Required	Description
`ownerResource`	`string`	required	The owner resource type the metafields are scoped to (e.g. "products", "variants"); must match the definition's ownerType.
`ownerId`	`string`	required	The id of the owner record the metafields belong to.

Query parameters

Name	Type	Required	Description
`page`	`integer`	-	The collection page number
`itemsPerPage`	`integer`	-	The number of items per page
`properties[]`	`string[]`	-	Allows you to reduce the response to contain only the properties you need. If your desired property is nested, you can address it using nested arrays. Example: properties[]={propertyName}&properties[]={anotherPropertyName}&properties[{nestedPropertyParent}][]={nestedProperty}
`id[]`	`string[]`	-	Only the items with one of these ids, each a UUID or the item IRI.

Response

200 - Metafield collection

Format

Property Type Required Description

search object -

Show search fields

Property Type Required Description

@type string -

mapping object[] -

Show mapping fields

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

template string -

variableRepresentation string -

totalItems integer -

view object -

Show view fields

Property	Type	Required
`@id`	`string`	-
`@type`	`string`	-
`first`	`string \| null`	-
`last`	`string \| null`	-
`next`	`string \| null`	-
`previous`	`string \| null`	-

member Metafield[] required

Show member fields

Property	Type	Required	Description
`@context`	`string \| object`	-
`@id`	`string`	required
`@type`	`string`	required
`createdAt`	`string`	-	The date and time when the resource was created (ISO 8601 format).
`definition`	`string \| null`	-	The `MetafieldDefinition` this metafield is an instance of. Requires the `metafields:read` scope. Returned null when the scope is missing.
`id`	`string`	-	The resource's unique identifier (UUID).
`metaobject`	`array`	-	The referenced metaobject(s). Populated when ?expand=metaobject is requested and the field type is metaobject_reference or list__metaobject_reference. Requires the `metaobjects:read` scope. Returned empty when the scope is missing.
`ownerId`	`string \| null`	-	The id of the owner record the metafield is attached to.
`ownerResource`	`string`	required	The type of resource that the metafield is attached to.
`updatedAt`	`string`	-	The date and time when the resource was last modified (ISO 8601 format).
`value`	`string`	-	This property supports translations. The data stored in the metafield. Always stored as a string, regardless of the metafield's type.

Errors

403 - Access denied. The caller is missing one or more permissions required for this operation.

Content-Type: application/problem+json

Property	Type	Required	Description
`@context`	`string \| object`	-
`@id`	`string`	required
`@type`	`string`	required
`detail`	`string`	-
`missingPermissions`	`string[]`	-	Permissions that the caller is missing for this operation. Present only when the 403 is caused by a denied permission.
`status`	`integer`	-
`title`	`string`	-
`type`	`string`	-