Skip to content

Search the docs

API v2 is in public beta: endpoints and fields can change before general availability. See the changelog

GET/account/help_docs

Costs 1 rate-limit point · Rate limits

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.

Pass query to search (at most 10 results; limit defaults to 10 and is capped there) or url to read; when both are given url wins, and with neither the call fails with 422 validation_failed. audience defaults to merchant. A page is returned in chunks of about 6,000 characters: when truncated is true, call again with the same url and offset set to next_offset. A url that is not a public STOQ doc fails with 422. No match is not an error: results is empty.

Also searched ashelp docshelp centersearch docshow do Idocumentationdeveloper docs

Query parameters

  • audiencestring

    Which docs to search, the help centre (merchant), the developer docs (developer) or both (all); defaults to merchant.

    One of merchantdeveloperall
    Default "merchant"
  • querystring

    Words to search the docs for. Ignored when url is given.

  • urlstring

    URL of a help.stoqapp.com or docs.stoqapp.com page to read in full, usually the url of a search result.

  • limitinteger

    Most search results to return, from 1 to 10 (default 10). Ignored when reading a page.

    Default 10
  • offsetinteger

    Character position to read a long page from; pass the next_offset a truncated page returned.

    Default 0

Returns

  • resultsarray of objects
    Show 4 child attributesHide child attributes
    • titlestring
      Example: string
    • urlstring
      Example: string
    • sourcestring
      Example: string
    • snippetstring
      Example: string
  • totalinteger
    Example: 1
  • notestring
    Example: string
  • urlstring
    Example: string
  • titlestring
    Example: string
  • sourcestring
    Example: string
  • contentstring
    Example: string
  • truncatedboolean
    Example: true
  • next_offsetinteger
    Example: 1

Errors

422
invalid_params

One or more fields failed the action's schema.

422
validation_failed

The action refused the request for a reason that is not a single bad field.

Any request can also fail with auth_invalid (401) or rate_limited (429).

Every error has the same shape: see Errors and the list of error codes.

GET/account/help_docs
curl "https://app.stoqapp.com/api/v2/external/account/help_docs" \
  -H "X-Auth-Token: $STOQ_API_KEY"
Response
{
  "results": [
    {
      "title": "string",
      "url": "string",
      "source": "string",
      "snippet": "string"
    }
  ],
  "total": 1,
  "note": "string",
  "url": "string",
  "title": "string",
  "source": "string",
  "content": "string",
  "truncated": true,
  "next_offset": 1
}