---
title: "Search help articles and PickFu examples"
method: GET
path: "/help/search"
tags: ["Help"]
---

# Search help articles and PickFu examples

`GET /help/search`

## Request

- Base URL: `https://api.pickfu.com/v1`
- URL: `https://api.pickfu.com/v1/help/search`
- Auth: HTTP bearer

Searches PickFu content matching the query. Use the `types` parameter to select help, example, case_study, and solution results. Results include titles, descriptions, body text, URLs, and response metadata.

## Query parameters

- `query` string, required
- `page` integer
- `per_page` integer
- `locale` 'en' | 'es' | 'ru' | 'zh' | 'ja'
- `types` string

## Response `200`

Default Response

- object
  - `totalCount` number
  - `pages` object
    - `page` number
    - `perPage` number
    - `totalPages` number
  - `data` object
    - `articles` object[]
      - `id` string, required
      - `type` 'help' | 'example' | 'case_study' | 'solution', required
      - `title` string
      - `description` string
      - `body` string: Result content. Help articles up to 8,000 characters return in full. Longer help articles return only the sections that best match the query, in article order, prefixed with a line starting "Excerpt:" that gives the full article URL; "…" marks skipped sections. Example, case study and solution results return their best-matching section.
      - `snippet` string
      - `url` string
      - `industries` string[]
      - `useCases` string[]
      - `pollType` string, nullable
      - `pollUrl` string, nullable
      - `company` string, nullable
  - `meta` object
    - `backend` 'intercom' | 'turbopuffer' | 'none', required
    - `locale` 'en' | 'es' | 'ru' | 'zh' | 'ja', required
    - `generationSha` string, nullable, required
    - `degraded` true

## Other responses

- `400`: Default Response

---

[API](https://skmtc.dev/pickfu/apis/pickfu-api.md) · [All operations](https://skmtc.dev/pickfu/apis/pickfu-api/llms.txt) · [OpenAPI document](https://skmtc.dev/pickfu/apis/pickfu-api/revisions/919fc58413ea?raw)