Search with the default profile

Search the site's content using the default search profile. Supports `q` (query), `locale`, `category`, `tag`, `page`, and `limit` parameters. Returns Lynkow Search hits with optional highlighted snippets and facet distribution.

GET/search

Base URLhttps://api.lynkow.com/public/{siteId}

View as markdown Install Lynkow Skills

curl --request GET \
  --url 'https://api.lynkow.com/public/{siteId}/search' \
  --header 'Authorization: Bearer $API_TOKEN'

"{\n  \"data\": [\n    {\n      \"id\": \"01J9R4QV6ZK7T0W1FH3DXB6P2Y\",\n      \"title\": \"Pricing\",\n      \"slug\": \"pricing\",\n      \"excerpt\": \"Simple pricing. Start free, scale when you grow.\",\n      \"locale\": \"en\",\n      \"type\": \"page\",\n      \"_formatted\": { \"title\": \"<mark>Pricing</mark>\" }\n    },\n    {\n      \"id\": \"01J9P1B5N4XZRWQEKM2H6A3T8C\",\n      \"title\": \"How we set our pricing\",\n      \"slug\": \"how-we-set-our-pricing\",\n      \"excerpt\": \"A behind-the-scenes look at the pricing model.\",\n      \"locale\": \"en\",\n      \"type\": \"content\",\n      \"_formatted\": { \"title\": \"How we set our <mark>pricing</mark>\" }\n    }\n  ],\n  \"meta\": {\n    \"total\": 2,\n    \"page\": 1,\n    \"totalPages\": 1,\n    \"perPage\": 20,\n    \"query\": \"pricing\",\n    \"processingTimeMs\": 6,\n    \"profile\": \"default\",\n    \"facetDistribution\": { \"type\": { \"page\": 1, \"content\": 1 } }\n  }\n}\n"

Feedback

Was this page helpful?