v1

latestSwagger 2.02026-07-17148179252.3 KB
Catalog

Returns a paginated categories collection from the BigCommerce Catalog.

get/catalog/categories

Query parameters

namestring

Filter items by name.

parent_idinteger

Filter items by parent_id.

page_titlestring

Filter items by page_title.

keywordstring

Filter items by keywords.

is_visibleinteger

Filter items by is_visible.

pageinteger

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

limitinteger

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

include_fieldsstring

Fields to include, in a comma-separated list. The ID and the specified fields will be returned.

exclude_fieldsstring

Fields to exclude, in a comma-separated list. The specified fields will be excluded from a response. The ID cannot be excluded.

Response

An array of category objects and metadata.