---
title: "Search help center articles"
url: https://docs.gleap.ai/en/reference/rest-api/get-shared-helpcenter-search
method: GET
path: "/shared/helpcenter/search"
api: "API Reference"
tag: "Help center"
operationId: "GetHelpcenterCollections"
updatedAt: "2026-11-01T18:40:15.677Z"
language: en
---

# Search help center articles

`GET https://api.gleap.io/v3/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).

## Example request

```bash
curl --request GET \
  --url https://api.gleap.io/v3/shared/helpcenter/search
```

## Responses

### 200 (`application/json`)

Ok

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

```json
{
  "session": {},
  "project": {
    "apiUrl": "string",
    "region": "string",
    "defaultDomain": "string",
    "flowConfig": {}
  }
}
```