Search a specific profile

Search using a named profile. The profile's scope, searchable subset, displayed subset, sort, facets and result limits are applied server-side. Boosted and featured content IDs (configured by the admin) are stitched in front of the baseline result set on page 1 with `_isBoosted`/`_isFeatured` flags. Returns `404` if the profile does not exist, `403` on the public endpoint if the profile is private, `503` if search is not enabled for the site.

Required permissions

search.viewcontents.view

GET/search/{profileSlug}

Base URLhttps://api.lynkow.com/v1

Path parameters

profileSlugstringrequired

View as markdown Install Lynkow Skills

curl --request GET \
  --url 'https://api.lynkow.com/v1/search/<profileSlug>' \
  --header 'Authorization: Bearer $API_TOKEN'

{
  "data": [
    {
      "id": "abc-123",
      "path": "/docs/api/pagination",
      "slug": "paginating-list-responses",
      "title": "Paginating list responses",
      "categories": [
        {
          "name": "API Reference",
          "slug": "api-reference"
        }
      ],
      "_isFeatured": true
    }
  ],
  "meta": {
    "page": 1,
    "query": "pagination",
    "total": 4,
    "perPage": 5,
    "profile": "api-docs",
    "totalPages": 1,
    "processingTimeMs": 3
  }
}

Feedback

Path parameters

Was this page helpful?