v5

latestOpenAPI 3.0.02026-08-04258282491.7 KB
Help center

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

get/shared/helpcenter/search

Response

Ok

{"stackTrail":"paths:/shared/helpcenter/search:get:responses:200:content:application/json:schema:properties:domainRedirect","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/shared/helpcenter/search:get:responses:200:content:application/json:schema:properties:redirectUrl","oasType":"schema","type":"unknown"}
{"stackTrail":"paths:/shared/helpcenter/search:get:responses:200:content:application/json:schema:properties:data","oasType":"schema","type":"unknown"}