BigCommerce Docs

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

{
  "data": [
    {
      "id": 19,
      "parent_id": 0,
      "name": "Garden",
      "description": "<p>This is the garden description</p>",
      "views": 125,
      "sort_order": 2,
      "page_title": "Garden Supplies and Tools",
      "meta_keywords": [
        "garden, plants, tools"
      ],
      "meta_description": "Find all your gardening needs including tools, plants, and accessories.",
      "layout_file": "category.html",
      "image_url": "https://cdn8.bigcommerce.com/s-123456/product_images/garden-category.jpg",
      "is_visible": true,
      "search_keywords": "garden tools, plants, outdoor",
      "default_product_sort": "use_store_settings",
      "custom_url": {
        "url": "/garden/",
        "is_customized": false
      }
    },
    {
      "id": 20,
      "parent_id": 0,
      "name": "Publications",
      "description": "<p>Books and magazines related to gardening and outdoor living.</p>",
      "views": 78,
      "sort_order": 4,
      "page_title": "Gardening Publications",
      "meta_keywords": [
        "books, magazines, gardening"
      ],
      "meta_description": "Explore our collection of gardening books and magazines.",
      "layout_file": "category_with_facets.html",
      "image_url": "https://cdn8.bigcommerce.com/s-123456/product_images/publications-category.png",
      "is_visible": true,
      "search_keywords": "gardening books, magazines",
      "default_product_sort": "use_store_settings",
      "custom_url": {
        "url": "/publications/",
        "is_customized": false
      }
    },
    {
      "id": 21,
      "parent_id": 0,
      "name": "Kitchen",
      "description": "<p>Kitchenware and cooking accessories for your home.</p>",
      "views": 200,
      "sort_order": 3,
      "page_title": "Kitchen Essentials",
      "meta_keywords": [
        "kitchen, cookware, utensils"
      ],
      "meta_description": "Shop kitchen essentials including cookware, utensils, and gadgets.",
      "layout_file": "category_with_facets.html",
      "image_url": "https://cdn8.bigcommerce.com/s-123456/product_images/kitchen-category.jpg",
      "is_visible": true,
      "search_keywords": "kitchen tools, cookware, utensils",
      "default_product_sort": "use_store_settings",
      "custom_url": {
        "url": "/kitchen/",
        "is_customized": false
      }
    },
    {
      "id": 22,
      "parent_id": 0,
      "name": "Utility",
      "description": "<p>Utility items for everyday use and maintenance.</p>",
      "views": 90,
      "sort_order": 5,
      "page_title": "Utility Products",
      "meta_keywords": [
        "utility, tools, maintenance"
      ],
      "meta_description": "Utility products for home and garden maintenance.",
      "layout_file": "category_with_facets.html",
      "image_url": "https://cdn8.bigcommerce.com/s-123456/product_images/utility-category.jpg",
      "is_visible": true,
      "search_keywords": "tools, maintenance, utility",
      "default_product_sort": "use_store_settings",
      "custom_url": {
        "url": "/utility/",
        "is_customized": false
      }
    },
    {
      "id": 23,
      "parent_id": 0,
      "name": "Shop All",
      "description": "<p>Browse all products available in our store.</p>",
      "views": 350,
      "sort_order": 0,
      "page_title": "Shop All Products",
      "meta_keywords": [
        "all products, store"
      ],
      "meta_description": "Shop all products across all categories in our store.",
      "layout_file": "category_with_facets.html",
      "image_url": "https://cdn8.bigcommerce.com/s-123456/product_images/shop-all-category.jpg",
      "is_visible": true,
      "search_keywords": "all products, store",
      "default_product_sort": "use_store_settings",
      "custom_url": {
        "url": "/shop-all/",
        "is_customized": false
      }
    },
    {
      "id": 39,
      "parent_id": 19,
      "name": "Bath",
      "description": "<p>Bath and spa products for relaxation and comfort.</p>",
      "views": 60,
      "sort_order": 0,
      "page_title": "Bath Products",
      "meta_keywords": [
        "bath, spa, relaxation"
      ],
      "meta_description": "Discover bath and spa products to enhance your relaxation.",
      "layout_file": "category.html",
      "image_url": "https://cdn8.bigcommerce.com/s-123456/product_images/bath-category.jpg",
      "is_visible": true,
      "search_keywords": "bath, spa, relaxation",
      "default_product_sort": "use_store_settings",
      "custom_url": {
        "url": "/garden/bath/",
        "is_customized": false
      }
    }
  ],
  "meta": {
    "pagination": {
      "total": 6,
      "count": 6,
      "per_page": 50,
      "current_page": 1,
      "total_pages": 1,
      "links": {
        "current": "?page=1&limit=50"
      }
    }
  }
}

When possible, use the Catalog Trees - Get all categories endpoint instead.

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

Note: The default rate limit for this endpoint is 40 concurrent requests.

When possible, use the [Catalog Trees - Get all categories](/developer/api-reference/rest/admin/catalog/category-trees/categories/get-all-categories) endpoint instead. Returns a list of *Categories*. Optional filter parameters can be passed in. **Note:** The default rate limit for this endpoint is 40 concurrent requests.

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

idintegerOptional

Filter items by category ID.

id:inlist of integersOptional

Explicitly include objects by passing a comma-separated list of IDs.

id:not_inlist of integersOptional

Exclude objects by passing a comma-separated list of IDs.

id:minintegerOptional

id:maxintegerOptional

id:greaterintegerOptional

id:lessintegerOptional

namestringOptional

Filter items by name.

name:likestringOptional

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

parent_idintegerOptional

Filter items by parent_id. If the category is a child or sub-category it can be filtered with the parent_id.

parent_id:inlist of integersOptional

parent_id:minintegerOptional

parent_id:maxintegerOptional

parent_id:greaterintegerOptional

parent_id:lessintegerOptional

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.

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.

sortenumOptional

Controls the sort order of the response, for example, sort=name.

Allowed values:

name: sort categories in alphabetical order by category name.
id: sort in ascending order by category ID.
parent_id: sort in ascending order by the ID of the parent category.
sort_order: sort in ascending order by sort order value.

Controls the sort order of the response, for example, `sort=name`. Allowed values: - `name`: sort categories in alphabetical order by category name. - `id`: sort in ascending order by category ID. - `parent_id`: sort in ascending order by the ID of the parent category. - `sort_order`: sort in ascending order by sort order value.

Allowed values:

pageintegerOptional

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

limitintegerOptional

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

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.

Response

datalist of objects

metaobject

Data about the response, including pagination and collection totals.

List Categories

Authentication

OAuth scopes

Authentication header

Further reading

Path parameters

Headers

Query parameters

Response

OAuth scopes

Authentication header

Further reading