Skip to main content
GET
/
search
/
api
/
v1
/
search
Search the catalog
curl --request GET \
  --url https://www.closient.com/search/api/v1/search
{
  "query": "<string>",
  "total_count": 1,
  "results": [
    {
      "type": "product",
      "id": "<string>",
      "name": "<string>",
      "rank": 1,
      "description": "",
      "metadata": {}
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.closient.com/llms.txt

Use this file to discover all available pages before exploring further.

Query Parameters

​
q
string
required

Search query text. Supports quoted phrases ("trail mix"), exclusion (trail -mix), and OR operators.

Required string length: 1 - 255
​
type
enum<string>[]

Filter results to one or more resource collections. Repeat the parameter to include multiple (e.g. ?type=product&type=brand). Omit to search all three.

Resource types returned by the catalog search endpoint.

Each result row carries one of these in its type field. The GET /search endpoint accepts the same values via the repeated ?type= query parameter to filter results to a subset.

Available options:
product,
brand,
retailer
​
limit
integer
default:25

Maximum number of results to return. Capped at 100.

Required range: 1 <= x <= 100

Response

200 - application/json

OK

Response envelope for GET /search.

Wraps the matched rows with the original query and a result count. Results are pre-sorted by rank descending. total_count reports the size of the returned list, not the size of the corpus — this endpoint truncates to limit and does not paginate.

​
query
string
required

The search query that was executed (echoed back for client-side correlation).

​
total_count
integer
required

Number of results in this response. Always equals len(results).

Required range: x >= 0
​
results
CatalogSearchResultOut · object[]

Matched rows sorted by rank descending.