---
title: "Search help center articles"
method: GET
path: "/shared/helpcenter/search"
tags: ["Help center"]
---

# Search help center articles

`GET /shared/helpcenter/search`

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

## Response `200`

Ok

- object
  - `domainRedirect` unknown, required
  - `redirectUrl` unknown, required
  - `session` object, required
    - `gleapHash` unknown, required
    - `gleapId` unknown, required
    - `userName` unknown, required
    - `userEmail` unknown, required
    - `userId` unknown, required
  - `project` object, required
    - `apiUrl` string, required
    - `region` string, required
    - `defaultDomain` string, required
    - `customDomain` unknown, required
    - `apiKey` unknown, required
    - `flowConfig` object, required
      - `localizationOptions` unknown, required
      - `operatorAvatarImage` unknown, required
      - `hideBranding` unknown, required
      - `backgroundColor` unknown, required
      - `headerColor` unknown, required
      - `color` unknown, required
      - `helpcenterConfig` unknown, required
    - `name` unknown, required
  - `data` unknown, required

## Changes

- **2026-09-19** `14b91b55d21f` — 2 info
  - added the required property `project/apiUrl` to the response with the `200` status
  - added the required property `project/region` to the response with the `200` status

[Change history](https://skmtc.dev/gleap/apis/gleap-server/changes/shared/helpcenter/search/get.md)

---

[API](https://skmtc.dev/gleap/apis/gleap-server.md) · [All operations](https://skmtc.dev/gleap/apis/gleap-server/llms.txt) · [OpenAPI document](https://skmtc.dev/gleap/apis/gleap-server/revisions/0a92e15c9803?raw)