Resources

Forms

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

Resource	Description
GET /form	Get all forms in your account
POST /form	Add a new form to your account
GET /form/:id	Get the details of the specified form
PUT /form/:id	Update the specified form
DELETE /form/:id	Delete the specified form
POST /form/:id/copy	Create 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.

Resourcve	Description
GET /folder	Get all folders in your account
POST /folder	Add a new folder to your account
GET /folder/:id	Get the details of the specified folder
PUT /folder/:id	Update the specified folder
DELETE /folder/:id	Delete the specified folder

Fields

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

Resource	Description
GET /form/:id/field	Get all fields for the specified form
POST /form/:id/field	Add a new field to the specified form
GET /field/:id	Get the details of the specified field
PUT /field/:id	Update the specified field
DELETE /field/:id	Delete the specified field

Submissions

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

Resource	Description
GET /form/:id/submission	Get all submissions for the specified form
POST /form/:id/submission	Add a new submission to the specified form
GET /submission/:id	Get the details of the specified submission
PUT /submission/:id	Update the specified submission
DELETE /submission/:id	Delete 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.

Resource	Description
GET /form/:id/partialsubmission	Get all partial submissions for the specified form
GET /partialsubmission/:id	Get the details of the specified partial submission
DELETE /partialsubmission/:id	Delete the specified partial submission

Confirmation Emails

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

Resource	Description
GET /form/:id/confirmation	Get all confirmation emails for the specified form
POST /form/:id/confirmation	Create a new confirmation email to the specified form
GET /confirmation/:id	Get the details of the specified confirmation email
PUT /confirmation/:id	Update the specified confirmation email
DELETE /confirmation/:id	Delete the specified confirmation email

Notification Emails

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

Resource	Description
GET /form/:id/notification	Get all notification emails for the specified form
POST /form/:id/notification	Add a new notification email to the specified form
GET /notification/:id	Get details for the specified notification email
PUT /notification/:id	Update the specified notification email
DELETE /notification/:id	Delete the specified notification email

Webhooks

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

Resource	Description
GET /form/:id/webhook	Get all webhooks for the specified form
POST /form/:id/webhook	Add a new webhook to the specified form
GET /webhook/:id	Get details for the specified webhook
PUT /webhook/:id	Update the specified webhook
DELETE /webhook/:id	Delete the specified webhook