# PostalForm Projects Public API

**Canonical:** https://apis.io/apis/postalform-com/postalform-projects-public-api/  
**Provider:** PostalForm — https://apis.io/providers/postalform-com/  
**Base URL:** https://projects.postalform.com/api/v1  
**Documentation:** https://projects.postalform.com/docs

PostalForm Projects Public API is one of 4 APIs that [PostalForm](https://apis.io/providers/postalform-com/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification. Tagged areas include Physical Mail, Print & Mail, Webhook, Documents, and Certified Mail. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and a getting-started guide.

Developer mail infrastructure for server-side applications: per-workspace bearer API keys with a free simulated test mode (pf_test_) and a live mode on prepaid credits (pf_live_), two-step PDF upload, final-price quotes with a pricing_version, Idempotency-Key letter and postcard orders, order timelines with carrier tracking and electronic return receipts, signed fulfillment webhooks (PostalForm-Signature) with retries and replay, credit balance, ledger, top-up and auto-refill, and key rotation. 25 operations under /api/v1, OpenAPI 3.1.0 (info.version 2026-05-06) served at https://projects.postalform.com/openapi.json. Also provisionable as postalform/mail through Stripe Projects.

## Operations (27)

| Method | Path | Summary |
|---|---|---|
| POST | `/api/v1/documents/upload-intent` | Create a PDF upload intent. |
| POST | `/api/v1/documents/{document_id}/complete` | Mark an uploaded document complete after the object is present. |
| POST | `/api/v1/letters/quotes` | Quote a mailpiece. |
| POST | `/api/v1/letters` | Create a test or live mail order from a quote. |
| GET | `/api/v1/letters/{order_id}` | Retrieve a mail order, timeline, tracking fields, and customer webhook events. |
| GET | `/api/v1/letters/{order_id}/document.pdf` | Preview or download the PDF for a letter order. |
| GET | `/api/v1/letters/{order_id}/return-receipt.pdf` | Download a stored USPS electronic return receipt. |
| GET | `/api/v1/return-receipts/export.zip` | Export stored electronic return receipts in bulk. |
| POST | `/api/v1/postcards/quotes` | Quote a postcard mailpiece. |
| POST | `/api/v1/postcards` | Create a test or live postcard order from a postcard quote. |
| GET | `/api/v1/postcards/{order_id}` | Retrieve a postcard order, timeline, tracking fields, and customer webhook events. |
| GET | `/api/v1/postcards/{order_id}/document.pdf` | Preview or download the PDF for a postcard order. |
| GET | `/api/v1/webhook-endpoints` | List customer webhook endpoints for the workspace. |
| POST | `/api/v1/webhook-endpoints` | Configure a customer webhook endpoint for status events. |
| DELETE | `/api/v1/webhook-endpoints/{endpoint_id}` | Disable a customer webhook endpoint. |
| POST | `/api/v1/webhook-endpoints/{endpoint_id}/rotate-secret` | Rotate a customer webhook endpoint signing secret. |
| GET | `/api/v1/webhook-events` | List customer webhook events for the workspace. |
| POST | `/api/v1/webhook-events/{event_id}/replay` | Queue a customer webhook event for replay. |
| GET | `/api/v1/credits/balance` | Get prepaid credit balance. |
| GET | `/api/v1/credits/payment-methods` | List saved live billing payment methods. |
| POST | `/api/v1/credits/payment-methods/setup-session` | Create a Checkout setup session for live credit auto-refill. |
| GET | `/api/v1/credits/auto-refill` | Get credit auto-refill threshold policies. |
| POST | `/api/v1/credits/auto-refill` | Configure the credit auto-refill threshold for the authenticated key mode. |
| GET | `/api/v1/credits/ledger` | List prepaid credit ledger entries. |
| GET | `/api/v1/api-keys` | List API key prefixes and status. |
| POST | `/api/v1/api-keys/rotate` | Rotate a test or live API key. |
| POST | `/api/v1/credits/checkout-session` | Create a prepaid credit top-up checkout session. |

## Machine-readable artifacts (7)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/postalform-com/refs/heads/main/openapi/postalform-com-projects-openapi.json
- **OpenAPI** — https://projects.postalform.com/openapi.json
- **Documentation** — https://projects.postalform.com/docs
- **APIReference** — https://projects.postalform.com/openapi.json
- **GettingStarted** — https://postalform.com/developer-mail-api
- **Webhooks** — https://raw.githubusercontent.com/api-evangelist/postalform-com/refs/heads/main/asyncapi/postalform-com-projects-webhooks.yml
- **Overlay** — https://raw.githubusercontent.com/api-evangelist/postalform-com/refs/heads/main/overlays/postalform-com-projects-overlay.yaml

## Other PostalForm APIs (3)

- [PostalForm Machine Payments API](https://apis.io/apis/postalform-com/postalform-machine-payments-api/)
- [PostalForm MCP Server](https://apis.io/apis/postalform-com/postalform-mcp-server/)
- [PostalForm A2A Agent](https://apis.io/apis/postalform-com/postalform-a2a-agent/)

## Tags

Physical Mail, Print & Mail, Webhook, Documents, Certified Mail

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/postalform-com/postalform-projects-public-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/postalform-com/.