API Reference

Print Mail

Postcards

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Get Postcard Preview

GET/print-mail/v1/postcards/{id}/url

Retrieve a postcard preview URL.

This is only available for customers with our document management addon, which offers document generation and hosting capabilities. This endpoint has a much higher rate limit than the regular order retrieval endpoint, so it is suitable for customer-facing use-cases.

Path ParametersExpand Collapse

id: string

ReturnsExpand Collapse

id: string

A unique ID prefixed with postcard_

object: string

url: string

A signed URL linking to the order preview PDF. The link remains valid for 15 minutes from the time of the API call.

formaturi

Get Postcard Preview

HTTP

HTTP

TypeScript

Python

curl https://api.postgrid.com/print-mail/v1/postcards/$ID/url \
    -H "X-API-Key: $POSTGRID_PRINT_MAIL_API_KEY"

200 example

{
  "id": "postcard_123456",
  "object": "postcard_url",
  "url": "https://pg-prod-bucket-1.s3.amazonaws.com/test/postcard_uzTtdAPiBVC25hjEYDvyLk?AWSAccessKeyId=AKIA5GFUILSULWTWCR64&Expires=1736192587&Signature=GS6kJK3fgWWy49jq1Yb%2FRn%2BQjD4%3D"
}

Returns Examples

200 example

{
  "id": "postcard_123456",
  "object": "postcard_url",
  "url": "https://pg-prod-bucket-1.s3.amazonaws.com/test/postcard_uzTtdAPiBVC25hjEYDvyLk?AWSAccessKeyId=AKIA5GFUILSULWTWCR64&Expires=1736192587&Signature=GS6kJK3fgWWy49jq1Yb%2FRn%2BQjD4%3D"
}