List Categories

GET

https://api.bigcommerce.com/stores/:store_hash/v3/catalog/trees/categories

GET

/stores/:store_hash/v3/catalog/trees/categories

curl https://api.bigcommerce.com/stores/store_hash/v3/catalog/trees/categories \
     -H "Accept: application/json" \
     -H "X-Auth-Token: <apiKey>"

{
  "data": [
    {
      "name": "Bath",
      "category_id": 12,
      "category_uuid": "d1964756-5e1d-4c72-9fa0-e1a3f7be4a34",
      "tree_id": 1,
      "parent_id": 2,
      "description": "<p>We offer a wide variety of products perfect for relaxing</p>",
      "views": 1050,
      "sort_order": 3,
      "page_title": "Bath",
      "meta_keywords": [
        "string"
      ],
      "meta_description": "string",
      "layout_file": "category.html",
      "image_url": "https://cdn8.bigcommerce.com/s-123456/product_images/d/fakeimage.png",
      "is_visible": true,
      "search_keywords": "string",
      "default_product_sort": "use_store_settings",
      "url": {
        "path": "string",
        "is_customized": true
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 246,
      "count": 5,
      "per_page": 5,
      "current_page": 1,
      "total_pages": 50,
      "links": {
        "previous": "?limit=5&page=1",
        "current": "?limit=5&page=2",
        "next": "?limit=5&page=3"
      }
    }
  }
}

Returns a list of categories.

To get a specific category in a tree, provide a category ID.

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.

Path parameters

store_hashstringRequired

Permanent ID of the BigCommerce store.

Query parameters

category_uuid:inlist of stringsOptional

Filter using a comma-separated list of one or more category UUIDs. To use category IDs, use the category_id:in parameter.

category_uuid:not_inlist of stringsOptional

Filter using a comma-separated list to exclude one or more category UUIDs. To exclude using category IDs, use the category_id:not_in parameter.

category_id:inlist of integersOptional

Filter using a comma-separated list of one or more category IDs. To use category UUIDs, use the category_uuid:in parameter.

category_id:not_inlist of integersOptional

Filter using a comma-separated list to exclude one or more category IDs. To exclude using category UUIDs, use the category_uuid:not_in parameter.

tree_id:inlist of integersOptional

Filter using a comma-separated list of one or more category tree IDs.

tree_id:not_inlist of integersOptional

Filter using a comma-separated list to exclude one or more category tree IDs.

parent_id:inlist of integersOptional

Filter results to those whose parent ID is in this list.

parent_id:not_inlist of integersOptional

Filter results to those whose parent ID is not in this list.

page_titlestringOptional

Filter items by page_title.

page_title:likestringOptional

Filter items by substring in the page title property. page_title:like=oil returns both Soil and mulch and Oil pastels.

namestringOptional

Filter items by name.

name:likestringOptional

Filter items by substring in the name property. name:like=stick returns both Stickers and Lipstick colors.

keywordstringOptional

Filter items by keywords found in the name, description, or sku fields, or in the brand name.

is_visiblebooleanOptional

Filter items based on whether the product is currently visible on the storefront.

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.

pageintegerOptional

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

limitintegerOptional<=250Defaults to 50

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

Response

List of categories.

datalist of objectsOptional

metaobjectOptional

Errors

403

Forbidden Error

422

Unprocessable Entity Error