About Help Center end user search

Return to top

3 Comments

  • Soo Hian

    Hi, can we only set the search to find Help Center articles and not community topics/posts?

    Is there a setting for this? Thank you!

    0
  • Amy Gracer

    You probably have scoped to KB enabled. See this section

    Scoped search in Knowledge base

    This might also help.

    search helper

    {{search}}

    Inserts a search box.

    Parameters

    None.

    Attributes
    • scoped (optional, boolean) If scoped is true and the helper is on the category, section, or article page, searches only the articles in the current category. If the helper is on the topic or post page, searches only the posts in the current topic. Default is false.
    • submit (optional, boolean) If true, render the submit button. Default is false.
    • instant (optional, boolean) If true, enables Instant Search to provide HC article suggestions while you type in the search box. Instant Search article suggestions do not respect the scoped parameter if it is set.
    • class (optional, string) class name to be added to the form
    • placeholder (optional, string) placeholder value for the search input element
    Availability
    • All pages
    Example
    {{search}}
    
    Output

    If inserted in the Home page:

    <section class="search-box">
      <form accept-charset="UTF-8" action="/hc/en-us/search" class="search" method="get" role="search">
        <div style="display:none"><input name="utf8" type="hidden" value="&#x2713;" /></div>
        <input id="query" name="query" placeholder="Search" type="search" />
        <input name="commit" type="submit" value="Search" />
      </form>
    </section>
    0
  • Dave Dyson
    Zendesk Community Manager

    Hi Karolina,

    Not directly, but you can use the Help Center API to get search results in JSON format: Help Center API – Search

    0

Please sign in to leave a comment.

Powered by Zendesk