List Category Metafields

GET

https://api.bigcommerce.com/stores/:store_hash/v3/catalog/categories/:category_id/metafields

GET

/stores/:store_hash/v3/catalog/categories/:category_id/metafields

curl https://api.bigcommerce.com/stores/store_hash/v3/catalog/categories/1/metafields \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>"

200Response

{
  "data": [
    {
      "key": "Location",
      "namespace": "Warehouse Locations",
      "permission_set": "app_only",
      "value": "4HG",
      "date_created": "1973-01-20T21:34:57.903Z",
      "date_modified": "1990-12-30T00:29:23.515Z",
      "description": "Location in the warehouse",
      "id": 6,
      "resource_id": 111,
      "resource_type": "category"
    },
    {
      "key": "Location",
      "namespace": "Warehouse Locations",
      "permission_set": "read",
      "value": "4HG",
      "date_created": "1973-01-20T21:34:57.903Z",
      "date_modified": "1990-12-30T00:29:23.515Z",
      "description": "Location in the warehouse",
      "id": 7,
      "resource_id": 111,
      "resource_type": "category"
    }
  ],
  "meta": {
    "pagination": {
      "total": 2,
      "count": 2,
      "per_page": 50,
      "current_page": 1,
      "total_pages": 1,
      "links": {
        "current": "?page=1&limit=50"
      }
    }
  }
}

Returns a list of Metafields on a Category. Optional filter parameters can be passed in.

Authentication

X-Auth-Tokenstring

OAuth scopes

UI Name	Permission	Parameter
Products	modify	`store_v2_products`
Products	read-only	`store_v2_products_read_only`

Authentication header

Header	Argument	Description
`X-Auth-Token`	`access_token`	For more about API accounts that generate `access_token`s, see our Guide to API Accounts.

Path parameters

category_idintegerRequired

The ID of the Category to which the resource belongs.

store_hashstringRequired

Permanent ID of the BigCommerce store.

Query parameters

idintegerOptional

Filter items by metafield ID.

id:inlist of integersOptional

Explicitly include objects by passing a comma-separated list of IDs.

id:not_inlist of integersOptional

Exclude objects by passing a comma-separated list of IDs.

id:minintegerOptional

Filter results to those whose ID is greater than or equal to this value.

id:maxintegerOptional

Filter results to those whose ID is less than or equal to this value.

id:greaterintegerOptional

Filter results to those whose ID is greater than this value.

id:lessintegerOptional

Filter results to those whose ID is less than this value.

keystringOptional

Filter based on a metafieldʼs key.

namespacestringOptional

Filter based on a metafieldʼs namespaces.

pageintegerOptional

Specifies the page number in a limited (paginated) list of results.

limitintegerOptional

Controls the number of items per page in a limited (paginated) list of results.

include_fieldslist of stringsOptional

Fields to include, in a comma-separated list. The ID and the specified fields will be returned.

exclude_fieldslist of stringsOptional

Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.

Response

datalist of objectsOptional

metaobjectOptional

Data about the response, including pagination and collection totals.