Skip to main content
GET
Search / Autocomplete Categories
Before calling this endpoint, make sure you’ve generated an API token and picked the correct domain. See Authentication & Base URLs. Use this to power a category typeahead. For term suggestions, use Auto-Suggestions; for the product search itself, use Search Products.

Headers

x-tenant-id
string
required

Identifies your organization. Ensures data isolation per tenant.

x-workspace-id
string
required

Identifies the workspace within your organization. Scopes resources to a specific workspace.

x-environment-id
string
required

Identifies the environment you are targeting. Scopes the call to a specific deployment environment.

Query Parameters

catalog_id
string<uuid>
required

Catalog to search categories within.

q
string
required

Text query to match categories against.

locale
string

Locale for the category names.

limit
integer
default:10

Maximum number of categories to return.

skip
integer
default:0

Number of categories to skip.

Response

Success.

Catalog categories matching the query.

categories
object[]

Matching categories, ordered by relevance. Empty when nothing matches.

total_count
integer

Total number of matching categories, before limit and skip are applied.