Search the docs
API v2 is in public beta: endpoints and fields can change before general availability. See the changelog
/account/help_docsCosts 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
audiencestringWhich docs to search, the help centre (merchant), the developer docs (developer) or both (all); defaults to merchant.
One ofmerchantdeveloperallDefault"merchant"querystringWords to search the docs for. Ignored when url is given.
urlstringURL of a help.stoqapp.com or docs.stoqapp.com page to read in full, usually the url of a search result.
limitintegerMost search results to return, from 1 to 10 (default 10). Ignored when reading a page.
Default10offsetintegerCharacter position to read a long page from; pass the next_offset a truncated page returned.
Default0
Returns
resultsarray of objectsShow 4 child attributesHide child attributes
titlestringExample:stringurlstringExample:stringsourcestringExample:stringsnippetstringExample:string
totalintegerExample:1notestringExample:stringurlstringExample:stringtitlestringExample:stringsourcestringExample:stringcontentstringExample:stringtruncatedbooleanExample:truenext_offsetintegerExample:1
Errors
invalid_paramsOne or more fields failed the action's schema.
validation_failedThe 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.
curl "https://app.stoqapp.com/api/v2/external/account/help_docs" \
-H "X-Auth-Token: $STOQ_API_KEY"const res = await fetch("https://app.stoqapp.com/api/v2/external/account/help_docs", {
headers: {
"X-Auth-Token": process.env.STOQ_API_KEY,
},
});
const data = await res.json();import os
import requests
res = requests.get(
"https://app.stoqapp.com/api/v2/external/account/help_docs",
headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.stoqapp.com/api/v2/external/account/help_docs")
req = Net::HTTP::Get.new(uri, "X-Auth-Token" => ENV["STOQ_API_KEY"])
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body)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"const res = await fetch("https://app.stoqapp.com/api/v2/external/account/help_docs?audience=merchant&url=https%3A%2F%2Fexample.com", {
headers: {
"X-Auth-Token": process.env.STOQ_API_KEY,
},
});
const data = await res.json();import os
import requests
res = requests.get(
"https://app.stoqapp.com/api/v2/external/account/help_docs?audience=merchant&url=https%3A%2F%2Fexample.com",
headers={"X-Auth-Token": os.environ["STOQ_API_KEY"]},
)
data = res.json()require "net/http"
require "json"
uri = URI("https://app.stoqapp.com/api/v2/external/account/help_docs?audience=merchant&url=https%3A%2F%2Fexample.com")
req = Net::HTTP::Get.new(uri, "X-Auth-Token" => ENV["STOQ_API_KEY"])
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
data = JSON.parse(res.body){
"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
}{
"errors": [
"Invalid API key"
],
"code": "auth_invalid",
"details": [
{
"code": "auth_invalid",
"message": "Invalid API key",
"path": null,
"value": null,
"expected": null
}
]
}{
"errors": [
"name is required"
],
"code": "validation_failed",
"details": [
{
"code": "validation_failed",
"message": "name is required",
"path": null,
"value": null,
"expected": null
}
]
}{
"errors": [
"Rate limit exceeded"
],
"code": "rate_limited",
"details": [
{
"code": "rate_limited",
"message": "Rate limit exceeded",
"path": null,
"value": null,
"expected": null
}
]
}