---
title: "Retrieve the help docs"
description: "Search STOQ's docs, or read one page in full: the help centre (help.stoqapp.com, audience merchant) and the developer docs (docs.stoqapp.com, audience developer). Use for how-to and explanation questions — how a feature "
url: https://docs.stoqapp.com/v2-reference/account-help-docs/retrieve-the-help-docs/
api: "API v2 reference"
method: GET
path: "/account/help_docs"
---

# Retrieve the help docs

`GET https://app.stoqapp.com/api/v2/external/account/help_docs`

Search STOQ's docs, or read one page in full: the help centre (help.stoqapp.com, audience merchant) and the developer docs (docs.stoqapp.com, audience developer). Use for how-to and explanation questions: how a feature works, how to set something up, what a setting means, how to call the API. Search first, then read the page that matches by its url before relaying step-by-step instructions; the snippets are previews.

## Query parameters

- `audience` (string) One of: `merchant`, `developer`, `all`.
- `query` (string)
- `url` (string)
- `limit` (integer)
- `offset` (string)

Rate limit: this call costs 1 point ([rate limits](https://docs.stoqapp.com/docs/rate-limits/)).

## Examples

### Retrieve the help docs

```sh
curl "https://app.stoqapp.com/api/v2/external/account/help_docs" \
  -H "X-Auth-Token: $STOQ_API_KEY"
```

### Retrieve the help docs filtered by audience and url

```sh
curl "https://app.stoqapp.com/api/v2/external/account/help_docs?audience=merchant&url=https%3A%2F%2Fexample.com" \
  -H "X-Auth-Token: $STOQ_API_KEY"
```

## 200

Success: the requested resource.

## 401

Missing or invalid `X-Auth-Token`.

```json
{
  "errors": [
    "Invalid API key"
  ],
  "code": "auth_invalid",
  "details": [
    {
      "code": "auth_invalid",
      "message": "Invalid API key",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

## 422

The request failed validation.

```json
{
  "errors": [
    "name is required"
  ],
  "code": "validation_failed",
  "details": [
    {
      "code": "validation_failed",
      "message": "name is required",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```

## 429

Rate limited: cost-weighted per token (read 1, write 2; 360 points / 60s). Check `Retry-After`.

```json
{
  "errors": [
    "Rate limit exceeded"
  ],
  "code": "rate_limited",
  "details": [
    {
      "code": "rate_limited",
      "message": "Rate limit exceeded",
      "path": null,
      "value": null,
      "expected": null
    }
  ]
}
```