Global search
curl --request GET \
--url http://localhost:3000/v1/search{
"products": [
{
"id": "<string>",
"title": "<string>",
"subtitle": "<string>",
"badge": "<string>",
"badgeVariant": "<string>",
"secondBadge": "<string>",
"secondBadgeVariant": "<string>",
"imageUrl": "<string>",
"logoUrl": "<string>"
}
],
"scrapedProducts": [
{
"id": "<string>",
"title": "<string>",
"subtitle": "<string>",
"badge": "<string>",
"badgeVariant": "<string>",
"secondBadge": "<string>",
"secondBadgeVariant": "<string>",
"imageUrl": "<string>",
"logoUrl": "<string>"
}
],
"orders": [
{
"id": "<string>",
"title": "<string>",
"subtitle": "<string>",
"badge": "<string>",
"badgeVariant": "<string>",
"secondBadge": "<string>",
"secondBadgeVariant": "<string>",
"imageUrl": "<string>",
"logoUrl": "<string>"
}
],
"sweeps": [
{
"id": "<string>",
"title": "<string>",
"subtitle": "<string>",
"badge": "<string>",
"badgeVariant": "<string>",
"secondBadge": "<string>",
"secondBadgeVariant": "<string>",
"imageUrl": "<string>",
"logoUrl": "<string>"
}
],
"staff": [
{
"id": "<string>",
"title": "<string>",
"subtitle": "<string>",
"badge": "<string>",
"badgeVariant": "<string>",
"secondBadge": "<string>",
"secondBadgeVariant": "<string>",
"imageUrl": "<string>",
"logoUrl": "<string>"
}
],
"customers": [
{
"id": "<string>",
"title": "<string>",
"subtitle": "<string>",
"badge": "<string>",
"badgeVariant": "<string>",
"secondBadge": "<string>",
"secondBadgeVariant": "<string>",
"imageUrl": "<string>",
"logoUrl": "<string>"
}
],
"retailers": [
{
"id": "<string>",
"title": "<string>",
"subtitle": "<string>",
"badge": "<string>",
"badgeVariant": "<string>",
"secondBadge": "<string>",
"secondBadgeVariant": "<string>",
"imageUrl": "<string>",
"logoUrl": "<string>"
}
],
"locations": [
{
"id": "<string>",
"title": "<string>",
"subtitle": "<string>",
"badge": "<string>",
"badgeVariant": "<string>",
"secondBadge": "<string>",
"secondBadgeVariant": "<string>",
"imageUrl": "<string>",
"logoUrl": "<string>"
}
]
}Search
Global search
Search across all entity types: products, orders, sweeps, staff, customers, retailers, and locations.
GET
/
v1
/
search
Global search
curl --request GET \
--url http://localhost:3000/v1/search{
"products": [
{
"id": "<string>",
"title": "<string>",
"subtitle": "<string>",
"badge": "<string>",
"badgeVariant": "<string>",
"secondBadge": "<string>",
"secondBadgeVariant": "<string>",
"imageUrl": "<string>",
"logoUrl": "<string>"
}
],
"scrapedProducts": [
{
"id": "<string>",
"title": "<string>",
"subtitle": "<string>",
"badge": "<string>",
"badgeVariant": "<string>",
"secondBadge": "<string>",
"secondBadgeVariant": "<string>",
"imageUrl": "<string>",
"logoUrl": "<string>"
}
],
"orders": [
{
"id": "<string>",
"title": "<string>",
"subtitle": "<string>",
"badge": "<string>",
"badgeVariant": "<string>",
"secondBadge": "<string>",
"secondBadgeVariant": "<string>",
"imageUrl": "<string>",
"logoUrl": "<string>"
}
],
"sweeps": [
{
"id": "<string>",
"title": "<string>",
"subtitle": "<string>",
"badge": "<string>",
"badgeVariant": "<string>",
"secondBadge": "<string>",
"secondBadgeVariant": "<string>",
"imageUrl": "<string>",
"logoUrl": "<string>"
}
],
"staff": [
{
"id": "<string>",
"title": "<string>",
"subtitle": "<string>",
"badge": "<string>",
"badgeVariant": "<string>",
"secondBadge": "<string>",
"secondBadgeVariant": "<string>",
"imageUrl": "<string>",
"logoUrl": "<string>"
}
],
"customers": [
{
"id": "<string>",
"title": "<string>",
"subtitle": "<string>",
"badge": "<string>",
"badgeVariant": "<string>",
"secondBadge": "<string>",
"secondBadgeVariant": "<string>",
"imageUrl": "<string>",
"logoUrl": "<string>"
}
],
"retailers": [
{
"id": "<string>",
"title": "<string>",
"subtitle": "<string>",
"badge": "<string>",
"badgeVariant": "<string>",
"secondBadge": "<string>",
"secondBadgeVariant": "<string>",
"imageUrl": "<string>",
"logoUrl": "<string>"
}
],
"locations": [
{
"id": "<string>",
"title": "<string>",
"subtitle": "<string>",
"badge": "<string>",
"badgeVariant": "<string>",
"secondBadge": "<string>",
"secondBadgeVariant": "<string>",
"imageUrl": "<string>",
"logoUrl": "<string>"
}
]
}Documentation Index
Fetch the complete documentation index at: https://docs.switchyard.run/llms.txt
Use this file to discover all available pages before exploring further.
Query Parameters
Search query
Required string length:
1 - 200Example:
"john"
Max items per category
Required range:
1 <= x <= 20Example:
5
Response
200 - application/json
Global search results
Global search response
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I