Documentation

List documentation pages

The documentation index: slug, title, description, HTML URL, and markdown URL for every page. Cursor-paginated. Fetch a page's content with /docs/{slug}.

get/docs

Request

  • Base URL: https://yappy.biz/api/v1
  • URL: https://yappy.biz/api/v1/docs
  • 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:docs)

Query parameters

limitinteger

How many items to return, 1 to 100.

cursorstring

Opaque cursor from a previous response's pagination.next_cursor. Pass it back verbatim; do not construct one.

Response

A page of documentation entries

object'list' required

Type discriminator.

totalinteger

How many items exist in total.

Changes

No recorded changes to this operation across all 1 revision of this API.