Help center

Search help center articles

Changed on

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).

get/shared/helpcenter/search

Request

  • Base URL
    https://api.gleap.io/v3
  • URL
    https://api.gleap.io/v3/shared/helpcenter/search
  • Auth
    none required

Response

Ok

domainRedirectunknown required
redirectUrlunknown required
dataunknown required

Changes

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status