Skip to navigation
RESTAdminCatalogCategory Trees

List Category Trees

Returns a list of category trees.

Authentication

X-Auth-Tokenstring

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.

Path parameters

store_hashstringRequired
Permanent ID of the BigCommerce store.

Headers

AcceptstringRequiredDefaults to application/json

The MIME type of the response body.

Query parameters

id:inlist of integersOptional

Filter by supplying a comma-separated list of category tree IDs.

channel_id:inlist of integersOptional

Filter by supplying a comma-separated list of channel IDs.

Response

List of category trees.
datalist of objectsOptional
metaobjectOptional

Errors

403
Forbidden Error
422
Unprocessable Entity Error