List search profiles

Returns the search profiles configured for the site. Profiles let an admin define multiple scoped search experiences (e.g. one per documentation space) with their own searchable/displayed fields, sort and facets, all sharing a single underlying search index.

Required permissions

search.profiles.view

GET/search/profiles

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

View as markdown Install Lynkow Skills

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

{
  "data": [
    {
      "name": "Default",
      "slug": "default",
      "facets": [],
      "maxLimit": 100,
      "description": "Default search profile covering all indexed content.",
      "defaultLimit": 20
    },
    {
      "name": "API Docs",
      "slug": "api-docs",
      "facets": [
        "categories.slug",
        "tags.slug"
      ],
      "maxLimit": 50,
      "description": "Search scoped to the API reference.",
      "defaultLimit": 20
    }
  ]
}

Feedback

Was this page helpful?