# List articles

URL: https://docs.hanzo.ai/docs/openapi/help/get-help-articles

> Returns the public knowledge base: the help center's Published, publicly-visible articles as cards.

`GET /v1/help/articles`

> [Help →](https://docs.hanzo.ai/docs/openapi/help) · [All API references →](https://docs.hanzo.ai/docs/openapi) · [Get started →](https://docs.hanzo.ai/docs/guides)

|               |                                         |
| ------------- | --------------------------------------- |
| **Address**   | `https://api.hanzo.ai/v1/help/articles` |
| **Method**    | `GET`                                   |
| **Operation** | `get_help_articles`                     |
| **Auth**      | `Authorization: Bearer $HANZO_API_KEY`  |

Returns the public knowledge base: the help center's Published,
publicly-visible articles as cards. The org is server-fixed and the
status/is\_public filter is server-set, so neither the tenant nor the visibility
can be widened by the caller. A deployment with no help center answers 404, and
one whose center has not installed the Help model answers an empty list.

## Request

2 fields.

| Field      | In    | Type    | Required | Description                                                                                                    |
| ---------- | ----- | ------- | -------- | -------------------------------------------------------------------------------------------------------------- |
| `category` | query | string  | —        | Category narrows the list to one knowledge-base section, matched against the article's category by exact name. |
| `limit`    | query | integer | —        | Limit caps how many articles are returned.                                                                     |

## Response

| Status    | Body                 | Meaning |
| --------- | -------------------- | ------- |
| `200`     | help.helpArticleList | ok      |
| `default` | problem-details      | refused |

`200` body — 6 fields.

| Field              | In   | Type                    | Always | Description                                                                                                   |
| ------------------ | ---- | ----------------------- | ------ | ------------------------------------------------------------------------------------------------------------- |
| `data`             | body | help.helpArticleCard\[] | —      | Data is the matching Published, public articles, newest write order last — the store's order, not a ranking.  |
| `data[].category`  | body | string                  | —      | Category is the name of the knowledge-base section the article sits in, or empty when it is filed under none. |
| `data[].excerpt`   | body | string                  | —      | Excerpt is the short summary the author wrote for listings, or empty.                                         |
| `data[].slug`      | body | string                  | —      | Slug is the article's stable public identifier and the path segment /v1/help/articles/{slug} addresses it by. |
| `data[].title`     | body | string                  | —      | Title is the article's headline.                                                                              |
| `data[].updatedAt` | body | integer (int64)         | —      | UpdatedAt is the unix second the article was last written, in the help center's own store.                    |

Failure carries the platform error shape — see [Errors](https://docs.hanzo.ai/docs/errors).

## Examples

**CLI**

```bash
hanzo help articles list
```

**SDK**

**.ts**

```ts
import { Configuration, HelpApi } from 'hanzoai';

const api = new HelpApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getHelpArticles();
```

**.py**

```python
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import HelpApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = HelpApi(client).get_help_articles()
```

**.go**

```go
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.HelpAPI.GetHelpArticles(context.Background()).Execute()
if err != nil {
	return err
}
```

**.rs**

```rust
use hanzo_client::apis::{configuration::Configuration, help_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = help_api::get_help_articles(&cfg, Default::default()).await?;
```

**.java**

```java
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.HelpApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new HelpApi(client).getHelpArticles();
```

**HTTP**

```bash
curl https://api.hanzo.ai/v1/help/articles \
  -H "Authorization: Bearer $HANZO_API_KEY"
```

**MCP**

MCP reaches **help** through the `help` tool, which names its 4 operations with its own verbs — this one among them, under a name only MCP declares. `describe` explains any of them:

```bash
curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "describe",
         "arguments": {
           "op": "list_help_articles"
         }
       }
     }'
```

---

[Help API](https://docs.hanzo.ai/docs/openapi/help) · [All Hanzo APIs](https://docs.hanzo.ai/docs/openapi) · [Interactive reference](https://docs.hanzo.ai/docs/openapi/reference)