Skip to main content
get_form and submit_form do not require API credentials. Forms are identified by a UUID that you obtain from the Paubox dashboard. The form management methods require a scoped API key; see Manage forms.

Instantiation

Get a form

Retrieve a form’s metadata, field schema, and rendered HTML/CSS:
Key fields in the response:

Submit a form

submit_form raises ValueError if form_data is empty or None.

Submitting with file attachments

The maximum total request size is 250 MB.
Each attachment is a dict with two keys:

Manage forms

The management methods require a scoped API key with the forms scope, passed as api_key. It can be the same key as PAUBOX_API_KEY if that key also has the forms scope.
Available methods: get_form_by_id, list_forms, create_form, update_form, archive_form, unarchive_form, copy_form, get_form_stats, list_submissions, export_submissions_csv, and export_submission_pdf. Calling one without a key raises ValueError.

Error handling