List PDF Templates
GET/api/pdf-templates
Returns every PDF template — the global templates plus every store-specific override.
settings:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Personal Access Token (sent as a Bearer token) with the settings scope (read access).
Each row carries only what a list needs: name, type, description, and the owning store (store_id and store_name, both null on a global template). The template markup and its variable schema are deliberately not included — fetch a single template to get those. Template types: purchase_order, sales_order, packing, quote, pick_list, vendor_credit, sales_credit. There is no server-side type filter — request the full list and filter by type on the client.
Request
Responses
- 200
- 401
- 403
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.