BigCommerce Docs

When possible, use the Catalog Trees - Get all categories endpoint instead. You can provide a category identifier using query parameters to retrieve a single category.

Returns a single Category. Optional 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. You can provide a category identifier using query parameters to retrieve a single category. Returns a single *Category*. Optional 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.

### 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

category_idstringRequired

Query parameters

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

dataobject

Common Category object properties.

metaobject

Response metadata.

Errors

404

Not Found Error

1	{
2	"data": {
3	"id": 1,
4	"parent_id": 0,
5	"name": "Bath",
6	"description": "<p>We offer a wide variety of products perfect for relaxing</p>",
7	"views": 1050,
8	"sort_order": 3,
9	"page_title": "Bath Essentials",
10	"search_keywords": "bath,relaxation,spa,soaps",
11	"meta_keywords": [
12	"bath",
13	"relaxation",
14	"spa"
15	],
16	"meta_description": "Discover our exclusive range of bath products designed to help you relax and rejuvenate.",
17	"layout_file": "category.html",
18	"is_visible": true,
19	"default_product_sort": "use_store_settings",
20	"image_url": "https://cdn8.bigcommerce.com/s-123456/product_images/d/bath-category.jpg",
21	"custom_url": {
22	"url": "/bath-essentials",
23	"is_customized": true
24	}
25	},
26	"meta": {}
27	}

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