Skip to main content

REST API

WebForms REST API allows deep integration with your 3rd party software. Please configure your REST API role permissions first before using it.

Get form information#

Get all available form information such as name, code, description texts, configuration options, fields and fieldsets.

Endpoint: /V1/webforms/form/#FORM ID#

#FORM ID# is the actual form id number you can see on Manage Forms page.

Submit the form#

Submit the form using the REST API. You can submit any custom data you would like to collect. Please use Hidden fields to store extra information with the submission.

Endpoint: /V1/webforms/form/#FORM ID#/submit

Accepted parameters#

ParameterDescription
field[FIELD ID]The value for the field. For example: field[15]=John & field[16]=Doe.
submitted_fromUse this parameter to set the page information where the form was submitted. It should be in JSON format: {"url":"URL of the page","title":"Title of the page"}
referrer_pageThis parameter stores URL of the referrer page that the customer came from. For example: https://some-partner-site.com
customer_idThe ID of the customer.
result_idSet the result ID if you want to update existing record.

Get form results#

Get all form submissions.

Endpoint: /V1/webforms/form/#FORM ID#/results

Get result by ID#

Get individual result information.

Endpoint: /V1/webforms/result/#RESULT ID#