List Sample Records for Preview
GET/api/pdf-templates/:id/sample-records
Lists the records a template can be previewed against, so a preview can be rendered from real data instead of sample data.
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).
The template's type decides which kind of record is searched — a sales order for sales-order and packing templates, a quote, a purchase order, a pick list, a sales credit or a vendor credit. A record returned here can never be one the template cannot render.
Path params:
- id: the ID of the template the records will be previewed against.
Returns up to 20 records, newest first. Pass the chosen id as sample_record_id when previewing.
Request
Responses
- 200
- 401
- 403
- 404
- 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.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
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.