# List metafields

> Retrieve the metafields stored on an owner record.
{/* generated:versioned-pages - edit _pm-authored, not this file */}

`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` | Yes      | The owner resource type the metafields are scoped to (e.g. "products", "variants"); must match the definition's ownerType. |
| `ownerId`       | `string` | Yes      | 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

| Property     | Type          | Required | Description |
| ------------ | ------------- | -------- | ----------- |
| `search`     | `object`      | -        |             |
| `totalItems` | `integer`     | -        |             |
| `view`       | `object`      | -        |             |
| `member`     | `Metafield[]` | Yes      |             |

## Errors

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

| Property             | Type               | Required | Description                                                                                                            |
| -------------------- | ------------------ | -------- | ---------------------------------------------------------------------------------------------------------------------- |
| `@context`           | `string \| object` | -        |                                                                                                                        |
| `@id`                | `string`           | Yes      |                                                                                                                        |
| `@type`              | `string`           | Yes      |                                                                                                                        |
| `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`           | -        |                                                                                                                        |

## Examples

### Example request

```bash
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'
```

### Example response

```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
}
```
