GET/v1/previews/{id}

Get a preview request with its signed image URLs

Scope templates.read

Path parameters

idstringrequired

Returns

11 fields of the 200 answer

idstringrequired

kindenumrequired

previewproof

templateIdstringrequired

templateVersionIdstringrequired

statusenumrequired

PENDINGRUNNINGREADYFAILED

paramsone ofrequired

urlsobjectrequired

issuesarray of objectsrequired

4 fields

codestringrequired

severityenumrequired

errorwarning

messagestringrequired

elementIdstring

errorstring or nullrequired

createdAtdate-timerequired

finishedAtdate-time or nullrequired

Responses

200Success

401Authentication required or API key invalid

403Permission or scope missing, organisation suspended

404Not found

429Rate limited for this API key and class; wait Retry-After seconds

otherError (RFC 9457 problem details)

Request

curl https://api.postbuddy.nl/v1/previews/obj_01J9Y2K8QF4T6W8Z0B2D4F6H8K \
  -H "Authorization: Bearer $POSTBUDDY_API_KEY"

import { PostBuddyClient } from '@postbuddy/sdk';

const client = new PostBuddyClient({ apiKey: process.env.POSTBUDDY_API_KEY! });

const result = await client.renders.getPreview('obj_01J9Y2K8QF4T6W8Z0B2D4F6H8K');

import os
from postbuddy import Client

client = Client(os.environ["POSTBUDDY_API_KEY"])

result = client.renders.get_preview("obj_01J9Y2K8QF4T6W8Z0B2D4F6H8K")

Response

{
  "id": "obj_01J9Y2K8QF4T6W8Z0B2D4F6H8K",
  "kind": "preview",
  "templateId": "tpl_01J9Y2K8QF4T6W8Z0B2D4F6H8K",
  "templateVersionId": "tv_01J9Y2K8QF4T6W8Z0B2D4F6H8K",
  "status": "READY",
  "params": {
    "variables": {
      "first_name": "Sanne"
    },
    "recipient": {
      "name": "Sanne de Vries",
      "addressLine1": "Oudegracht 112",
      "addressLine2": "2nd floor",
      "postalCode": "3511 AX",
      "city": "Utrecht",
      "country": "NL"
    },
    "side": "Example",
    "dpi": 1,
    "qrShortUrl": "https://example.com/r/Fq3ZtR8w"
  },
  "urls": {
    "key": "https://example.com/r/Fq3ZtR8w"
  },
  "issues": [
    {
      "code": "validation_failed",
      "severity": "error",
      "message": "The postal code is not valid",
      "elementId": "el_01J9Y2K8QF4T6W8Z0B2D4F6H8K"
    }
  ],
  "error": "Example",
  "createdAt": "2026-10-16T09:14:02.000Z",
  "finishedAt": "2026-10-16T09:14:02.000Z"
}

{
  "type": "https://docs.postbuddy.nl/errors/not_found",
  "title": "Not found",
  "status": 404,
  "code": "not_found",
  "detail": "Not found",
  "requestId": "req_01J9Y2K8QF4T6W8Z0B2D4F6H8K"
}