Skip to main content
GET
Search

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your API token.

Query Parameters

query
string
required

Search term to find matching content

Minimum string length: 1
type
enum<string>

Filter results by content type. If not specified, searches all types

Available options:
products,
pages,
collections,
events,
subscription_packages
limit
integer
default:10

Maximum number of results to return per type

Required range: 1 <= x <= 50

Response

Search results

query
string

The search query that was executed

totalResults
integer

Total number of results found across all types

results
object

Search results organised by content type