API Documentation

account Your user plan

Show you details regarding your current plan limits

get /api/v1/users/my-plan

account Account usage

Shows you details about your current plan usage

get /api/v1/users/my-stats

account Personalized offer

When you have enterprise deals with us...

get /api/v1/users/my-upgrade-plans

account Current public offer

Use this in order to get the public offer of our plans

get /api/v1/users/plans

authentication Change Password

Changes password of a user

post /api/v1/users/change-password

Parameter Description
old_password Old Password
new_password New password
confirm_password Confirm new password

authentication Create Account

Sign-Up?

post /api/v1/users/create-account

Parameter Description
user_nameUsername null
email Email
first_name First name
last_name Last name
password string
confirm_password strint

authentication Forgot password

Did you forgot your password?

post /api/v1/users/forgot-password

Parameter Description
email The email address associated to forgotten account

authentication Login

Login a user based on a username and password

post /api/v1/users/login

Parameter Description
username - Email or username
password - Plain text password

embed Get form JS embed code

Returns the JS code needed to embed a form

get /embed/{form_id}/{seo_form_name}.js

Parameter Description
form_id The ID of the form
seo_form_name A string with the form name (for SEO purposes). Eg: "support-form"

forms Forms list

Shows you the list with your forms

get /api/v1/forms/

forms Get form document

Retrieve the serialized JSON of a form document

get /api/v1/forms/{form_id}

Parameter Description
form_id - The ID of the form

forms Delete form

Deletes a form

delete /api/v1/forms/{form_id}

Parameter Description
form_id The ID of the form template

forms Get form templates

Get form templates in JSON format

get /api/v1/templates

forms Get form template document

Retrieve the serialized JSON of a form template

get /api/v1/templates/{form_id}

Parameter Description
form_id The ID of the form template

submission Submit data

Submits data to a form

post /api/v1/forms/{form_id}/submit

Parameter Description
form_id The ID of the form template
recaptcha The Google recaptcha code
submission The submission in JSON format

submission Get submissions

Get form submissions

get /api/v1/submissions/{form_id}

Parameter Description
form_id The ID of the form
limit <optional> integer - Limit number of results returned by api
skip <optional> integer - Skip number of results

submission Get submissions count

Get form number of submissions

get /api/v1/submissions/{form_id}/count

Parameter Description
form_id The ID of the form

submission Export submissions

Creates a submission export request in a given format. After the export is completed, an email is sent to the form owner containing a download link.

post /api/v1/submissions/{form_id}/export/{format}

Parameter Description
form_id The ID of the form
format Can be "json", "xls", or "csv"

submission Delete submission

Delete a submission

delete /api/v1/submissions/{form_id}/{submission_id}

Parameter Description
form_id The ID of the form
submission_id The ID of the submission