Skip to main content
New to Corsair? See API access, authentication, and error handling.

Coupons

create

coupons.create Create a coupon code on a form, with a fixed amount or percentage off. Risk: write
Input POST /v1/forms/{slug_or_id}/coupons. Output

delete

coupons.delete Delete a coupon code from a form. Risk: destructive
Input DELETE /v1/forms/{slug_or_id}/coupons/{code}. Output

get

coupons.get Get one coupon on a form by code. Risk: read
Input GET /v1/forms/{slug_or_id}/coupons/{code}. Output

list

coupons.list List the coupon codes on a form. Risk: read
Input GET /v1/forms/{slug_or_id}/coupons. Output

update

coupons.update Change a coupon (enable or disable, discount, expiry). Fields you leave out stay as they are. Risk: write
Input PUT /v1/forms/{slug_or_id}/coupons/{code}. Output

Fields

list

fields.list List the questions on a form: each field key, title and type. Submission answers are keyed by these field keys. Risk: read
Input GET /v1/forms/{slug_or_id}/fields. Output

Files

sign

files.sign Get a signed download link for a file uploaded in a submission. Links last 7 days. Risk: read
Input POST /v1/files/sign. Only works for files uploaded to your own forms. Output

Forms

get

forms.get Get one form by slug, custom slug or id. Risk: read
Input GET /v1/forms/{slug_or_id}. Output

list

forms.list List forms, newest first by default. Filter with search, page with limit and skip. Risk: read
Input GET /v1/forms. Stores id, title, slug, space id, live flag and submission count. Output

Partial Submissions

get

partialSubmissions.get Get one partial submission of a form. Risk: read
Input GET /v1/forms/{slug_or_id}/partial-submissions/{id}. Output

list

partialSubmissions.list List partial (unfinished) submissions of a form. Paperform keeps them only when partial submissions are turned on for the form. Risk: read
Input GET /v1/forms/{slug_or_id}/partial-submissions. Output

Products

get

products.get Get one product on a form by SKU. Risk: read
Input GET /v1/forms/{slug_or_id}/products/{sku}. Output

list

products.list List the products sold on a form, with price and stock. Risk: read
Input GET /v1/forms/{slug_or_id}/products. Output

update

products.update Change a product on a form (name, price, stock, min/max per order). Fields you leave out stay as they are. Risk: write
Input PUT /v1/forms/{slug_or_id}/products/{sku}. Business API. Output

Spaces

forms

spaces.forms List the forms in one space. Risk: read
Input GET /v1/spaces/{id}/forms. Output

get

spaces.get Get one space by id. Risk: read
Input GET /v1/spaces/{id}. Output

list

spaces.list List spaces (folders of forms). Risk: read
Input GET /v1/spaces. Output

Submissions

delete

submissions.delete Delete one submission. It cannot be recovered. Risk: destructive
Input DELETE /v1/forms/{slug_or_id}/submissions/{id}. The local row goes only after Paperform confirms. Output

get

submissions.get Get one submission of a form, with its answers. Risk: read
Input GET /v1/forms/{slug_or_id}/submissions/{id}. Output

list

submissions.list List the completed submissions of a form, with their answers keyed by field key. Filter by date or id, page with limit and skip. Risk: read
Input GET /v1/forms/{slug_or_id}/submissions. Stores id, form id and created date only. Output

Translations

list

translations.list List form translations (title and language). The mapping text is not stored. Risk: read
Input GET /v1/translations. Stores id, title and language; not the mapping. Output

Webhooks

create

webhooks.create Add a webhook that posts each new submission (and optionally partial submission) of a form to an https URL. Risk: write
Input POST /v1/forms/{slug_or_id}/webhooks. Business API. The target URL stays out of events. Output

delete

webhooks.delete Delete a webhook by id. Risk: destructive
Input DELETE /v1/webhooks/{id}. Business API. Output

list

webhooks.list List a form’s webhooks. Risk: read
Input GET /v1/forms/{slug_or_id}/webhooks. Output