List Category Metafields | BigCommerce Developer Center

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.

### 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](/developer/docs/overview/api-fundamentals/api-accounts#api-accounts). | ### Further reading For example requests and more information about authenticating BigCommerce APIs, see [Authentication and Example Requests](/developer/docs/overview/api-fundamentals/api-accounts#x-auth-token-header-example-requests). For more about BigCommerce OAuth scopes, see our [Guide to API Accounts](/developer/docs/overview/api-fundamentals/api-accounts#oauth-scopes). For a list of API status codes, see [API Status Codes](/developer/api-reference/rest/overview#rest-http-status-codes).

Path parameters

category_idstringRequired

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

id:maxintegerOptional

id:greaterintegerOptional

id:lessintegerOptional

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 objects

metaobject

Data about the response, including pagination and collection totals.

1	import requests
2
3	url = "https://api.bigcommerce.com/stores/store_hash/v3/catalog/categories/category_id/metafields"
4
5	headers = {"X-Auth-Token": "<apiKey>"}
6
7	response = requests.get(url, headers=headers)
8
9	print(response.json())

1	{
2	"data": [
3	{
4	"key": "Location",
5	"namespace": "Warehouse Locations",
6	"permission_set": "app_only",
7	"value": "4HG",
8	"date_created": "1973-01-20T21:34:57.903Z",
9	"date_modified": "1990-12-30T00:29:23.515Z",
10	"description": "Location in the warehouse",
11	"id": 6,
12	"resource_id": 111,
13	"resource_type": "category"
14	},
15	{
16	"key": "Location",
17	"namespace": "Warehouse Locations",
18	"permission_set": "read",
19	"value": "4HG",
20	"date_created": "1973-01-20T21:34:57.903Z",
21	"date_modified": "1990-12-30T00:29:23.515Z",
22	"description": "Location in the warehouse",
23	"id": 7,
24	"resource_id": 111,
25	"resource_type": "category"
26	}
27	],
28	"meta": {
29	"pagination": {
30	"total": 2,
31	"count": 2,
32	"per_page": 50,
33	"current_page": 1,
34	"total_pages": 1,
35	"links": {
36	"current": "?page=1&limit=50"
37	}
38	}
39	}
40	}