---
title: "List frequently asked questions"
method: GET
path: "/faq"
tags: ["Documentation"]
---

# List frequently asked questions

`GET /faq`

## Request

- Base URL: `https://yappy.biz/api/v1`
- URL: `https://yappy.biz/api/v1/faq`
- Auth: one of:
  - none
  - HTTP bearer
  - OAuth 2 (authorization code, authorization URL `https://yappy.biz/oauth/authorize`, token URL `https://yappy.biz/oauth/token`; client credentials, token URL `https://yappy.biz/oauth/token`, scopes: `read:faq`)

Question and answer pairs about Yappy — privacy, requirements, cost, permissions, and how it differs from other dictation tools. The same set is published as FAQPage structured data on the homepage.

## Query parameters

- `limit` integer
- `cursor` string

## Response `200`

A page of FAQ entries

- FaqList: A cursor-paginated page of FAQ entries.
  - `object` 'list', required: Type discriminator.
  - `data` Faq[], required: This page of items.
    - `object` 'faq', required: Type discriminator.
    - `id` string, required: Stable identifier for this entry.
    - `question` string, required: The question, as a user would ask it.
    - `answer` string, required: The answer, complete enough to quote.
    - `topic` string: Which area the question belongs to.
    - `sandbox` boolean: Present and true on sandbox fixtures.
  - `pagination` Pagination, required: Cursor pagination. When has_more is false, next_cursor is null.
    - `limit` integer, required: How many items this page holds at most.
    - `has_more` boolean, required: Whether another page exists.
    - `next_cursor` string, nullable, required: Opaque cursor for the next page, or null.
    - `next_url` string, uri, nullable: Fully-formed URL for the next page, or null.
  - `total` integer: How many items exist in total.

## Other responses

- `400`: The request was malformed
- `401`: The supplied credential is missing, expired, or invalid
- `403`: The credential is valid but lacks the required scope
- `429`: Too many requests
- `500`: Unexpected server error
- `503`: A dependency was unavailable

---

[API](https://skmtc.dev/yappy/apis/yappy-web-api.md) · [All operations](https://skmtc.dev/yappy/apis/yappy-web-api/llms.txt) · [OpenAPI document](https://skmtc.dev/yappy/apis/yappy-web-api/revisions/02b27cd526a7?raw)