List Shared Modifiers | BigCommerce Developer Center

Get all shared modifiers in the Catalog.

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).

Query parameters

pageintegerOptional

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

limitintegerOptional

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

idintegerOptional

Filter items by id.

namestringOptional

Filter items by name.

storefront_namestringOptional

Filter items by storefront_name.

typeenumOptional

Filter items by type.

sortenumOptional

Sort items.

Allowed values:

Response

An array of shared modifiers and metadata

datalist of objects

metaobject

Data about the response, including pagination and collection totals.

1	{
2	"data": [
3	{
4	"associated_products_qty": 0,
5	"id": 19,
6	"name": "Sleeve Length",
7	"option_type": "modifier",
8	"storefront_name": "Sleeve Length",
9	"type": "radio_buttons",
10	"config": [],
11	"required": true,
12	"values": [
13	{
14	"label": "Short",
15	"sort_order": 0,
16	"id": 25,
17	"is_default": false
18	},
19	{
20	"label": "Medium",
21	"sort_order": 1,
22	"id": 26,
23	"is_default": true
24	},
25	{
26	"label": "Long",
27	"sort_order": 2,
28	"id": 27,
29	"is_default": false
30	}
31	]
32	}
33	],
34	"meta": {
35	"pagination": {
36	"total": 1,
37	"count": 1,
38	"per_page": 50,
39	"current_page": 1,
40	"total_pages": 1,
41	"links": {
42	"current": "?page=1&limit=50"
43	}
44	}
45	}
46	}

1	curl https://api.bigcommerce.com/stores/store_hash/v3/catalog/shared-modifiers \
2	-H "X-Auth-Token: <apiKey>"