> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gleap.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Search help center articles

> Full-text search the published articles of a help center. Returns at most 30 hits, filtered to the
requested language and to the articles the current visitor session is allowed to see. Hits are returned
under `data.hits`, alongside the help center's `project` configuration and any `domainRedirect`.
Authentication: the `api-token` header must carry the help center domain (e.g. `acme-app.gleap.help` or
your custom domain); a `password` header is required for password-protected help centers; optional
`gleap-id`/`gleap-hash` headers resolve the visitor session for audience filtering. Query parameters:
`searchTerm` (required), `lang` (defaults to `en`, falling back to the help center's first configured
language), `collectionId` (restrict results to one collection).



## OpenAPI

````yaml https://api.gleap.io/api-docs.json get /shared/helpcenter/search
openapi: 3.0.0
info:
  title: gleap-server
  version: 14.0.0
  contact: {}
servers:
  - url: https://api.gleap.io/v3
security: []
paths:
  /shared/helpcenter/search:
    get:
      tags:
        - Help center
      summary: Search help center articles
      description: >-
        Full-text search the published articles of a help center. Returns at
        most 30 hits, filtered to the

        requested language and to the articles the current visitor session is
        allowed to see. Hits are returned

        under `data.hits`, alongside the help center's `project` configuration
        and any `domainRedirect`.

        Authentication: the `api-token` header must carry the help center domain
        (e.g. `acme-app.gleap.help` or

        your custom domain); a `password` header is required for
        password-protected help centers; optional

        `gleap-id`/`gleap-hash` headers resolve the visitor session for audience
        filtering. Query parameters:

        `searchTerm` (required), `lang` (defaults to `en`, falling back to the
        help center's first configured

        language), `collectionId` (restrict results to one collection).
      operationId: GetHelpcenterCollections
      parameters: []
      responses:
        '200':
          description: Ok
          content:
            application/json:
              schema:
                properties:
                  domainRedirect: {}
                  redirectUrl: {}
                  session:
                    properties:
                      gleapHash: {}
                      gleapId: {}
                      userName: {}
                      userEmail: {}
                      userId: {}
                    required:
                      - gleapHash
                      - gleapId
                      - userName
                      - userEmail
                      - userId
                    type: object
                  project:
                    properties:
                      apiUrl:
                        type: string
                      region:
                        type: string
                      defaultDomain:
                        type: string
                      customDomain: {}
                      apiKey: {}
                      flowConfig:
                        properties:
                          localizationOptions: {}
                          operatorAvatarImage: {}
                          hideBranding: {}
                          backgroundColor: {}
                          headerColor: {}
                          color: {}
                          helpcenterConfig: {}
                        required:
                          - localizationOptions
                          - operatorAvatarImage
                          - hideBranding
                          - backgroundColor
                          - headerColor
                          - color
                          - helpcenterConfig
                        type: object
                      name: {}
                    required:
                      - apiUrl
                      - region
                      - defaultDomain
                      - customDomain
                      - apiKey
                      - flowConfig
                      - name
                    type: object
                  data: {}
                required:
                  - domainRedirect
                  - redirectUrl
                  - session
                  - project
                  - data
                type: object
      security: []

````