GET /catalog/brands

Returns a list of brands. Optional filter parameters can be passed in.

Servers

https://api.bigcommerce.com/stores/{store_hash}/v3

Request headers

Name Type Required Description

Accept

String

Yes

The MIME type of the response body.

Default value: "application/json"

Query parameters

Name	Type	Required	Description
`exclude_fields[]`	Array	No	Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.
`id:min[]`	Array	No
`name:like`	String	No	Filter items by part of a name. For example, `name:like=new` returns brands with names that include `new`.
`sort`	String	No	Field name to sort by. Valid values: `"name"`
`include_fields[]`	Array	No	Fields to include, in a comma-separated list. The ID and the specified fields will be returned.
`id:in[]`	Array	No
`id`	Integer	No	Filter items by ID.
`id:max[]`	Array	No
`page`	Integer	No	Specifies the page number in a limited (paginated) list of products.
`id:not_in[]`	Array	No
`name`	String	No	Filter items by name.
`page_title`	String	No	Filter items by page_title.
`limit`	Integer	No	Controls the number of items per page in a limited (paginated) list of products.
`direction`	String	No	Sort direction. Acceptable values are: `asc`, `desc`. Valid values: `"desc"` `"asc"`
`id:greater[]`	Array	No
`id:less[]`	Array	No

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.