Skip to content

List Postscript keywords

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

GET/account/integrations/postscript/keywords

Costs 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 objects
    Show 2 child attributesHide child attributes
    • idstring
      Example: string
    • keywordstring
      Example: string

Errors

404
not_found

The path is valid but nothing with that id exists in this store.

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/integrations/postscript/keywords
curl "https://app.stoqapp.com/api/v2/external/account/integrations/postscript/keywords" \
  -H "X-Auth-Token: $STOQ_API_KEY"
Response
{
  "keywords": [
    {
      "id": "string",
      "keyword": "string"
    }
  ]
}