---
title: "Get Help Categories"
method: GET
path: "/api/v1/help/categories"
tags: ["help"]
---

# Get Help Categories

`GET /api/v1/help/categories`

获取帮助文档分类列表

## Query parameters

- `include_items` boolean

## Response `200`

Successful Response

- HelpCategoryResponse[]
  - `id` integer, required
  - `name` string, required
  - `description` string, nullable
  - `icon` string, nullable
  - `sort_order` integer, required
  - `items` HelpItemResponse[]
    - `id` integer, required
    - `category_id` integer, required
    - `title` string, required
    - `description` string, nullable
    - `external_url` string, required
    - `sort_order` integer, required
    - `click_count` integer

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.dev/qcode/apis/qcode-web.md) · [All operations](https://skmtc.dev/qcode/apis/qcode-web/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/qcode/qcode-web/revisions/2f2f5f49ffc7/schema)