---
title: "GET /catalog/brands/{brand_id}/metafields"
method: GET
path: "/catalog/brands/{brand_id}/metafields"
tags: ["Catalog"]
---

# GET /catalog/brands/{brand_id}/metafields

`GET /catalog/brands/{brand_id}/metafields`

Gets a `Metafield` object list, by `brand_id`.

## Query parameters

- `page` integer
- `limit` integer
- `key` string
- `namespace` string
- `include_fields` string
- `exclude_fields` string

## Response `200`

An array of metafields and metadata.

- MetaFieldCollectionResponse — Response payload for the BigCommerce API.
  - `data` Metafield[]
    - `permission_set` 'app_only' | 'read' | 'write' — Determines whether the field is completely private to the app that owns the field (`app_only`), or visible to other API consumers (`read`), or completely open for reading and writing to other apps (`write`).
    - `namespace` string — Namespace for the metafield, for organizational purposes.
    - `key` string — The name of the field, for example: `location_id`, `color`.
    - `value` string — The value of the field, for example: `1`, `blue`.
    - `description` string — Description for the metafields.
    - `resource_type` 'category' | 'brand' | 'product' | 'variant' — The type of resource with which the metafield is associated.
    - `resource_id` integer — The unique identifier for the resource with which the metafield is associated.
    - `id` integer — The unique identifier for the metafields.
    - `created_at` string, date-time — Date and time of the metafield's creation.
    - `updated_at` string, date-time — Date and time when the metafield was last updated.
  - `meta` CollectionMeta — Data about the response, including pagination and collection totals.
    - `pagination` Pagination — Data about the response, including pagination and collection totals.
      - `total` integer — Total number of items in the result set.
      - `count` integer — Total number of items in the collection response.
      - `per_page` integer — The amount of items returned in the collection per page, controlled by the limit parameter.
      - `current_page` integer — The page you are currently on within the collection.
      - `total_pages` integer — The total number of pages in the collection.
      - `links` object — Pagination links for the previous and next parts of the whole collection.
        - `previous` string — Link to the previous page returned in the response.
        - `current` string — Link to the current page returned in the response.
        - `next` string — Link to the next page returned in the response.

## Other responses

- `404` — The resource was not found.

---

[API](https://skmtc.dev/bigcommerce/apis/bigcommerce-api.md) · [All operations](https://skmtc.dev/bigcommerce/apis/bigcommerce-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/bigcommerce/bigcommerce-api/revisions/90efb67b99f3/schema)