Paperform
Paperform is an online form builder. The REST API (Standard or Business plan) covers forms, fields, submissions, partial submissions, spaces, e-commerce products, coupons, webhooks, translations, and uploaded file URLs.
Data Model
- Forms — identified by numeric id or slug; live under Spaces.
- Spaces — folders grouping forms (space_id).
- Form fields — keyed by field_key; inspect before programmatic submissions.
- Submissions — full responses; a global uuid can be fetched without the parent form id.
- Partial submissions — abandoned in-progress entries; global id works without form_id.
- Products — keyed by product_sku on payment forms.
- Coupons — keyed by coupon_code.
- Webhooks — form-scoped list; each webhook has a global webhook_id (Business API).
- Translations — account-level locale strings (Business API).
Key Patterns
- form_id is usually required for form-scoped reads and writes. Resolve it from the account form list or from forms listed inside a space.
- Combined get tools — omit resource id parameters to list; pass id/code/sku to fetch one row. Form lists support search by title or slug.
- Write payloads — mutating calls take JSON bodies matching Paperform's field names for that resource.
- Form creation — new forms are built in the Paperform dashboard; the API updates existing forms only.
- Pagination — list endpoints accept skip and limit (max 100). Submission lists also support after_id, before_id, date filters, and sort ASC|DESC.
- Rate limits — 429 responses include Retry-After and X-RateLimit-* headers; back off and retry.
Common Workflows
- Inventory — list spaces → list forms in a space → list fields on a form.
- Responses — list or filter submissions → fetch one by id → delete if needed.
- Commerce — list products/coupons → create via upsert tools → delete by sku/code.
- Integrations — list or create webhooks on a form; resolve file URLs from submission attachments when needed.
