For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dev Portal
DocsAPI ReferenceLearnCommunityChangelog
DocsAPI ReferenceLearnCommunityChangelog
    • About Our APIs
  • REST
    • Overview
      • Overview
        • Brands
            • GETList Brands
            • POSTCreate Brand
            • DELDelete Brands
            • GETGet Brand
            • PUTUpdate Brand
            • DELDelete Brand
        • Categories
        • Category Trees
        • Products
        • Product Modifiers
        • Product Variants
        • Product Variant Options
      • Payments
  • GraphQL
    • Overview
  • MCP
    • Overview
Dev Portal
LogoLogo
RESTAdminCatalogBrands

List Brands

GET
https://api.bigcommerce.com/stores/:store_hash/v3/catalog/brands
GET
/stores/:store_hash/v3/catalog/brands
$curl https://api.bigcommerce.com/stores/store_hash/v3/catalog/brands \
>     -H "Accept: application/json" \
>     -H "X-Auth-Token: <apiKey>" \
>     -H "Content-Type: application/json"
1{
2  "data": [
3    {
4      "name": "Sagaform",
5      "id": 35,
6      "page_title": "Sagaform Kitchenware",
7      "meta_keywords": [
8        "kitchen",
9        "cookware",
10        "dining"
11      ],
12      "meta_description": "Sagaform offers stylish kitchen and dining products.",
13      "search_keywords": "kitchen, cookware, dining, utensils",
14      "image_url": "https://cdn8.bigcommerce.com/s-jrah6gmn/product_images/k/sagaform-kitchenware.png",
15      "custom_url": {
16        "url": "/brands/Sagaform.html",
17        "is_customized": false
18      }
19    },
20    {
21      "name": "OFS",
22      "id": 36,
23      "page_title": "OFS Modern Furniture",
24      "meta_keywords": [
25        "modern",
26        "clean",
27        "contemporary"
28      ],
29      "meta_description": "OFS is a modern brand.",
30      "search_keywords": "kitchen, laundry, cart, storage",
31      "image_url": "https://cdn8.bigcommerce.com/s-jrah6gmn/product_images/o/ofs-modern-furniture.png",
32      "custom_url": {
33        "url": "/brands/OFS.html",
34        "is_customized": false
35      }
36    },
37    {
38      "name": "Common Good",
39      "id": 37,
40      "page_title": "Common Good Essentials",
41      "meta_keywords": [
42        "sustainable",
43        "eco-friendly",
44        "cleaning"
45      ],
46      "meta_description": "Common Good is a modern brand focused on sustainable products.",
47      "search_keywords": "cleaning, eco-friendly, sustainable",
48      "image_url": "https://cdn8.bigcommerce.com/s-jrah6gmn/product_images/k/screen%20shot%202018-05-07%20at%2012.24.24%20pm_1525785365__65102.png",
49      "custom_url": {
50        "url": "/brands/Common-Good.html",
51        "is_customized": false
52      }
53    },
54    {
55      "name": "BigCommerce",
56      "id": 38,
57      "page_title": "BigCommerce Platform",
58      "meta_keywords": [
59        "ecommerce",
60        "platform",
61        "store"
62      ],
63      "meta_description": "BigCommerce is a leading ecommerce platform.",
64      "search_keywords": "ecommerce, online store, platform",
65      "image_url": "https://cdn8.bigcommerce.com/s-jrah6gmn/product_images/b/bigcommerce-logo.png",
66      "custom_url": {
67        "url": "/bigcommerce/",
68        "is_customized": false
69      }
70    },
71    {
72      "name": "Test Brand One",
73      "id": 39,
74      "page_title": "Test Brand One",
75      "meta_keywords": [
76        "test",
77        "sample",
78        "brand"
79      ],
80      "meta_description": "Test Brand One is a sample brand for testing purposes.",
81      "search_keywords": "test, sample, brand",
82      "image_url": "https://cdn8.bigcommerce.com/s-jrah6gmn/product_images/q/apihqggzm__53766.jpg",
83      "custom_url": {
84        "url": "/test-brand-one/",
85        "is_customized": false
86      }
87    },
88    {
89      "name": "Fog Linen Work",
90      "id": 40,
91      "page_title": "Fog Linen Work",
92      "meta_keywords": [
93        "linen",
94        "home",
95        "textiles"
96      ],
97      "meta_description": "Fog Linen Work offers high-quality linen products.",
98      "search_keywords": "linen, home, textiles",
99      "image_url": "https://cdn8.bigcommerce.com/s-jrah6gmn/product_images/f/fog-linen-work.png",
100      "custom_url": {
101        "url": "/fog-linen-work/",
102        "is_customized": false
103      }
104    },
105    {
106      "name": "Barr-Co.",
107      "id": 41,
108      "page_title": "Barr-Co. Skincare",
109      "meta_keywords": [
110        "skincare",
111        "natural",
112        "beauty"
113      ],
114      "meta_description": "Barr-Co. provides natural skincare products.",
115      "search_keywords": "skincare, natural, beauty",
116      "image_url": "https://cdn8.bigcommerce.com/s-jrah6gmn/product_images/b/barr-co-skincare.png",
117      "custom_url": {
118        "url": "/barr-co/",
119        "is_customized": false
120      }
121    },
122    {
123      "name": "Thames & Hudson",
124      "id": 42,
125      "page_title": "Thames & Hudson Books",
126      "meta_keywords": [
127        "books",
128        "publishing",
129        "art"
130      ],
131      "meta_description": "Thames & Hudson is a renowned art book publisher.",
132      "search_keywords": "books, publishing, art",
133      "image_url": "https://cdn8.bigcommerce.com/s-jrah6gmn/product_images/t/thames-hudson-books.png",
134      "custom_url": {
135        "url": "/thames-hudson/",
136        "is_customized": false
137      }
138    },
139    {
140      "name": "Able Brewing",
141      "id": 43,
142      "page_title": "Able Brewing Equipment",
143      "meta_keywords": [
144        "coffee",
145        "brewing",
146        "equipment"
147      ],
148      "meta_description": "Able Brewing offers premium coffee brewing equipment.",
149      "search_keywords": "coffee, brewing, equipment",
150      "image_url": "https://cdn8.bigcommerce.com/s-jrah6gmn/product_images/a/able-brewing.png",
151      "custom_url": {
152        "url": "/able-brewing/",
153        "is_customized": false
154      }
155    },
156    {
157      "name": "Chemex",
158      "id": 44,
159      "page_title": "Chemex Coffee Makers",
160      "meta_keywords": [
161        "coffee",
162        "makers",
163        "brewing"
164      ],
165      "meta_description": "Chemex is known for its iconic coffee makers.",
166      "search_keywords": "coffee, makers, brewing",
167      "image_url": "https://cdn8.bigcommerce.com/s-jrah6gmn/product_images/c/chemex-coffee-maker.png",
168      "custom_url": {
169        "url": "/chemex/",
170        "is_customized": false
171      }
172    },
173    {
174      "name": "Kinfolk",
175      "id": 45,
176      "page_title": "Kinfolk Magazine",
177      "meta_keywords": [
178        "magazine",
179        "lifestyle",
180        "culture"
181      ],
182      "meta_description": "Kinfolk is a lifestyle and culture magazine.",
183      "search_keywords": "magazine, lifestyle, culture",
184      "image_url": "https://cdn8.bigcommerce.com/s-jrah6gmn/product_images/k/kinfolk-magazine.png",
185      "custom_url": {
186        "url": "/kinfolk/",
187        "is_customized": false
188      }
189    },
190    {
191      "name": "Iris Hantverk",
192      "id": 46,
193      "page_title": "Iris Hantverk Brushes",
194      "meta_keywords": [
195        "brushes",
196        "handmade",
197        "tools"
198      ],
199      "meta_description": "Iris Hantverk offers handmade brushes and tools.",
200      "search_keywords": "brushes, handmade, tools",
201      "image_url": "https://cdn8.bigcommerce.com/s-jrah6gmn/product_images/i/iris-hantverk-brushes.png",
202      "custom_url": {
203        "url": "/iris-hantverk/",
204        "is_customized": false
205      }
206    },
207    {
208      "name": "Gather Journal",
209      "id": 47,
210      "page_title": "Gather Journal",
211      "meta_keywords": [
212        "journal",
213        "lifestyle",
214        "culture"
215      ],
216      "meta_description": "Gather Journal is a lifestyle and culture publication.",
217      "search_keywords": "journal, lifestyle, culture",
218      "image_url": "https://cdn8.bigcommerce.com/s-jrah6gmn/product_images/g/gather-journal.png",
219      "custom_url": {
220        "url": "/gather-journal/",
221        "is_customized": false
222      }
223    },
224    {
225      "name": "Openhouse Magazine",
226      "id": 48,
227      "page_title": "Openhouse Magazine",
228      "meta_keywords": [
229        "magazine",
230        "architecture",
231        "design"
232      ],
233      "meta_description": "Openhouse Magazine covers architecture and design.",
234      "search_keywords": "magazine, architecture, design",
235      "image_url": "https://cdn8.bigcommerce.com/s-jrah6gmn/product_images/o/openhouse-magazine.png",
236      "custom_url": {
237        "url": "/openhouse-magazine/",
238        "is_customized": false
239      }
240    },
241    {
242      "name": "Smith Journal",
243      "id": 49,
244      "page_title": "Smith Journal",
245      "meta_keywords": [
246        "journal",
247        "culture",
248        "lifestyle"
249      ],
250      "meta_description": "Smith Journal is a culture and lifestyle publication.",
251      "search_keywords": "journal, culture, lifestyle",
252      "image_url": "https://cdn8.bigcommerce.com/s-jrah6gmn/product_images/s/smith-journal.png",
253      "custom_url": {
254        "url": "/smith-journal/",
255        "is_customized": false
256      }
257    }
258  ],
259  "meta": {
260    "pagination": {
261      "total": 15,
262      "count": 15,
263      "per_page": 50,
264      "current_page": 1,
265      "total_pages": 1,
266      "links": {
267        "current": "?page=1&limit=50"
268      }
269    }
270  }
271}
Returns a list of brands. Optional filter parameters can be passed in.
Was this page helpful?
Previous

Catalog - Brands

Next

Create Brand

Built with

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](/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

store_hashstringRequired
Permanent ID of the BigCommerce store.

Headers

AcceptstringRequiredDefaults to application/json
The [MIME type](https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types) of the response body.

Query parameters

idintegerOptional
Filter items by ID.
id:inlist of integersOptional
id:not_inlist of integersOptional
id:minlist of integersOptional
id:maxlist of integersOptional
id:greaterlist of integersOptional
id:lesslist of integersOptional
namestringOptional
Filter items by name.
name:likestringOptional

Filter items by part of a name. For example, name:like=new returns brands with names that include new.

page_titlestringOptional

Filter items by page_title.

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.

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.

sortenumOptional
Field name to sort by.
Allowed values:
directionenumOptional

Sort direction. Acceptable values are: asc, desc.

Allowed values:

Response

datalist of objects
metaobject
Data about the response, including pagination and collection totals.

Errors

403
Forbidden Error

OAuth scopes

UI NamePermissionParameter
Productsmodifystore_v2_products
Productsread-onlystore_v2_products_read_only

Authentication header

HeaderArgumentDescription
X-Auth-Tokenaccess_tokenFor more about API accounts that generate access_tokens, see our Guide to API Accounts.

Further reading

For example requests and more information about authenticating BigCommerce APIs, see Authentication and Example Requests.

For more about BigCommerce OAuth scopes, see our Guide to API Accounts.

For a list of API status codes, see API Status Codes.

The MIME type of the response body.