Resources

Forms

Forms are how information is collected and defines how that information is stored

ResourceDescription
GET /formGet all forms in your account
POST /formAdd a new form to your account
GET /form/:idGet the details of the specified form
PUT /form/:idUpdate the specified form
DELETE /form/:idDelete the specified form
POST /form/:id/copyCreate a copy of the specified form

Folders

Folders are how you organize your forms and are one way to assign form permissions to a group of forms.

ResourcveDescription
GET /folderGet all folders in your account
POST /folderAdd a new folder to your account
GET /folder/:idGet the details of the specified folder
PUT /folder/:idUpdate the specified folder
DELETE /folder/:idDelete the specified folder

Fields

Fields are the specific input elements that collect data for each form

ResourceDescription
GET /form/:id/fieldGet all fields for the specified form
POST /form/:id/fieldAdd a new field to the specified form
GET /field/:idGet the details of the specified field
PUT /field/:idUpdate the specified field
DELETE /field/:idDelete the specified field

Submissions

Submissions are collections of data that has been submitted via a form

ResourceDescription
GET /form/:id/submissionGet all submissions for the specified form
POST /form/:id/submissionAdd a new submission to the specified form
GET /submission/:idGet the details of the specified submission
PUT /submission/:idUpdate the specified submission
DELETE /submission/:idDelete the specified submission

Partial Submissions

Partial Submissions are collections of data that has been filled out on a form but not submitted. Required the Partial Submission plugin to be enabled on the form.

ResourceDescription
GET /form/:id/partialsubmissionGet all partial submissions for the specified form
GET /partialsubmission/:idGet the details of the specified partial submission
DELETE /partialsubmission/:idDelete the specified partial submission

Confirmation Emails

Confirmations Emails are the emails that are sent to the form submitter with data from their form submission

ResourceDescription
GET /form/:id/confirmationGet all confirmation emails for the specified form
POST /form/:id/confirmationCreate a new confirmation email to the specified form
GET /confirmation/:idGet the details of the specified confirmation email
PUT /confirmation/:idUpdate the specified confirmation email
DELETE /confirmation/:idDelete the specified confirmation email

Notification Emails

Notification Emails are the emails that are sent to the form owner with data from each form submission

ResourceDescription
GET /form/:id/notificationGet all notification emails for the specified form
POST /form/:id/notificationAdd a new notification email to the specified form
GET /notification/:idGet details for the specified notification email
PUT /notification/:idUpdate the specified notification email
DELETE /notification/:idDelete the specified notification email

Webhooks

Webhooks are automatic notifications (server to server communication) that are triggered with each form submission

ResourceDescription
GET /form/:id/webhookGet all webhooks for the specified form
POST /form/:id/webhookAdd a new webhook to the specified form
GET /webhook/:idGet details for the specified webhook
PUT /webhook/:idUpdate the specified webhook
DELETE /webhook/:idDelete the specified webhook