Skip to main content
GET
Search CMS / Content Items
Before calling this endpoint, make sure you’ve generated an API token and picked the correct domain. See Authentication & Base URLs. This searches CMS content rather than products, so the result shape differs — title, URL, image, and summary instead of price, SKU, and inventory. For products, 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 within.

q
string
required

Text query to match content against.

locale
string

Locale to search in, such as en-us. Determines which localized content is matched and returned.

skip
integer
default:0

Number of results to skip.

limit
integer
default:10

Maximum number of results to return.

type
string

Content type filter.

sort_by
enum<string>

Field to sort by.

Available options:
relevance,
created_at,
created_by,
title,
modified_at,
modified_by
sort_order
enum<string>

Sort direction.

Available options:
asc,
desc

Response

Success.

Matching content items for the query.

data
object[]

Matching content items for this page of results.

total
integer

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