---
title: "List help articles (POST form)"
method: POST
path: "/help-articles"
tags: ["Support"]
---

# List help articles (POST form)

`POST /help-articles`

## Request

- Base URL: `https://grape.cool/api/v1`
- URL: `https://grape.cool/api/v1/help-articles`
- Auth: none required

Returns help article titles, descriptions and reading times without the body. Filter by category to narrow it, then call getHelpArticle for the full text. Identical to the GET operation; the query arguments move into a JSON body.

## Request body

- object
  - `category` string: Limit the list to one category slug, as returned by listHelpCategories.

## Response `200`

Every matching article.

- object
  - `success` true, required
  - `data` HelpArticleSummary[], required
    - `slug` string, required: Identifier for getHelpArticle.
    - `title` string, required: Article title.
    - `description` string, required: What it answers.
    - `category` string, required: Category slug.
    - `readingMinutes` integer: Estimated reading time in minutes.
    - `updated` string: Date the article last changed.
    - `url` string, uri
  - `meta` Meta: Counts and echoed arguments that describe the payload.
    - `total` integer: How many items exist.
    - `returned` integer: How many items this response carries.
    - `query` string: The search term that was used.
    - `currency` string: ISO 4217 code the prices are quoted in.

## Other responses

- `400`: A parameter was missing or outside the allowed values.
- `404`: Nothing matches the identifier given.
- `429`: More than 1000 requests came from this IP address in an hour.
- `500`: The request could not be completed.

---

[API](https://skmtc.dev/grape/apis/grape-public-api.md) · [All operations](https://skmtc.dev/grape/apis/grape-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/grape/apis/grape-public-api/revisions/16061cbac2d4?raw)