Category search

post

https://api.clerk.io/v3/search/categories

Search for categories. Supports filters and facets

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Search request

key

string

required

Public key of the store.

visitor

string

Tracking setting for the given visitor. If set to 'auto', which is the default, an anonymous ID is generated.
See Cookieless tracking: https://help.clerk.io/help/tracking/how-clerk.io-delivers-cookieless-personalisation

query

string

Search query. And empty query will return all results

labels

array of strings

Labels to be applied to the API call

labels

flags

array of strings

Flags set for the call. Use for example for debugging or modifying general behavior

flags

attributes

array of strings

Array or Comma separated list of attributes that should be provided in the response.
"id" will be returned if left empty. Using "*" will return all attributes (use with moderation).

attributes

content

string

ID of the content related to this request.
This allows configuration of the content in My Clerk will be applied to this call:
filters, merchandising rules and labels.

exclude

array of objects

A list of ids to exclude from the results

exclude

facets

array of strings

Array or Comma separated list of attributes that you want to retrieve facets data for

facets

filter

array of strings

Filter the result on attribute values.
Filter can be a string or an array of string for multiple filters. Multiple filters are combined with "AND" boolean logic
See API documentation on Filters for details.

filter

language

string

enum

The language used for finding results. If not provided, the language configured on the Store will be used.

limit

integer

≥ 0

Max number of results to be returned. 20 by default

merchandising

array of strings

IDs of the merchandising campaigns to be applied to this request, additionally to
the campaigns configured in My Clerk. Use the trigger "API" on merchandising
campaigns to trigger them using this parameter.

merchandising

offset

integer

≥ 0

Offset for of results. 0 by default

semantic

number

Semantic-ness of a request, default value: 0.0

sort

array of strings

Array or Comma separated list of attributes to sort. Each attribute in the list must be followed by a colon (:) and the preferred sorting order.
Example: price:asc,name:desc

sort

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK

400Bad Request