API v.1
account
- Your user plan get /api/v1/users/my-plan
- Account usage get /api/v1/users/my-stats
- Personalized offer get /api/v1/users/my-upgrade-plans
- Current public offer get /api/v1/users/plans
authentication
- Change Password post /api/v1/users/change-password
- Create Account post /api/v1/users/create-account
- Forgot password post /api/v1/users/forgot-password
- Login post /api/v1/users/login
embed
forms
- Forms list get /api/v1/forms/
- Get form document get /api/v1/forms/{form_id}
- Delete form delete /api/v1/forms/{form_id}
- Get form templates get /api/v1/templates
- Get form template document get /api/v1/templates/{form_id}
submission
- Submit data post /api/v1/forms/{form_id}/submit
- Get submissions get /api/v1/submissions/{form_id}
- Get submissions count get /api/v1/submissions/{form_id}/count
- Export submissions post /api/v1/submissions/{form_id}/export/{format}
- Delete submission delete /api/v1/submissions/{form_id}/{submission_id}
account Your user plan
Show you details regarding your current plan limits
get /api/v1/users/my-plan
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 |
| 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 |
| 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 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 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" |