List Postscript keywords
API v2 is in public beta: endpoints and fields can change before general availability. See the changelog
/account/integrations/postscript/keywordsCosts 1 rate-limit point · Rate limits
The Postscript keywords on the saved Postscript account, to pick postscript.keyword and postscript.keyword_id for PATCH /account/integrations.
Needs a saved Postscript key (POST /account/integrations/postscript/connect); without one the call fails with 422 validation_failed. Each call asks Postscript live and returns its keywords as Postscript sends them, so the fields inside each keyword are Postscript's. A key Postscript rejects, or its rate limit, fails with 422 and Postscript's reason. Read only: save the choice with PATCH /account/integrations.
Also searched aspostscript keywords
Returns
keywordsarray of objectsShow 2 child attributesHide child attributes
idstringExample:stringkeywordstringExample:string
Errors
not_foundThe path is valid but nothing with that id exists in this store.
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/integrations/postscript/keywords" \
-H "X-Auth-Token: $STOQ_API_KEY"const res = await fetch("https://app.stoqapp.com/api/v2/external/account/integrations/postscript/keywords", {
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/integrations/postscript/keywords",
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/integrations/postscript/keywords")
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){
"keywords": [
{
"id": "string",
"keyword": "string"
}
]
}{
"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
}
]
}