curl --silent --show-error --fail-with-body --request GET \
--url 'https://api.example.com/api/products/search' \
--header 'x-widget-token: YOUR_API_KEY'
{
"ok": true,
"products": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"title": "Replacement tent pole set",
"description": "Two-person tent, green — replacement for damaged pole set.",
"descriptionHtml": "string",
"whyItMatches": "string",
"rating": 1.5,
"reviewCount": 1,
"price": "49.00",
"image": "https://cdn.example.com/products/tent-2p.jpg",
"url": "https://example.com/webhooks/stateset",
"handle": "acme-outdoors",
"tags": [
"priority"
]
}
]
}
Alias of GET /api/products
Widget identity is verified when signing is configured; tokenless compatibility does not establish tenant ownership…
GET
/
api
/
products
/
search
curl --silent --show-error --fail-with-body --request GET \
--url 'https://api.example.com/api/products/search' \
--header 'x-widget-token: YOUR_API_KEY'
{
"ok": true,
"products": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"title": "Replacement tent pole set",
"description": "Two-person tent, green — replacement for damaged pole set.",
"descriptionHtml": "string",
"whyItMatches": "string",
"rating": 1.5,
"reviewCount": 1,
"price": "49.00",
"image": "https://cdn.example.com/products/tent-2p.jpg",
"url": "https://example.com/webhooks/stateset",
"handle": "acme-outdoors",
"tags": [
"priority"
]
}
]
}
Widget identity is verified when signing is configured; tokenless compatibility does not establish tenant ownership. See the authentication and recovery guide for credential and retry rules.
Query parameters
Response
object
Status codes
| Code | Meaning |
|---|---|
200 | Products |
401 | Widget token missing, malformed, expired, from the future, or badly signed |
403 | Request org/agent disagrees with the widget token claims |
429 | Too many requests for this IP (scoped by verified org/agent) |
500 | Unhandled error |
Using this contract
Read the source OpenAPI document for declared schemas and alternatives. This page also includes documented corrections from the spec overlays. Example IDs and values are illustrative; replace them with records from your workspace.curl --silent --show-error --fail-with-body --request GET \
--url 'https://api.example.com/api/products/search' \
--header 'x-widget-token: YOUR_API_KEY'
{
"ok": true,
"products": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"title": "Replacement tent pole set",
"description": "Two-person tent, green — replacement for damaged pole set.",
"descriptionHtml": "string",
"whyItMatches": "string",
"rating": 1.5,
"reviewCount": 1,
"price": "49.00",
"image": "https://cdn.example.com/products/tent-2p.jpg",
"url": "https://example.com/webhooks/stateset",
"handle": "acme-outdoors",
"tags": [
"priority"
]
}
]
}
Last modified on November 13, 2026