Forms

Create, Update, Delete, List, and Show your Forms.

Form API Actions

Action	Method	Path
List	GET	/api/v1/forms
Show	GET	/api/v1/forms/:id
Create	POST	/api/v1/forms
Update	PUT	/api/v1/forms/:id
Delete	DELETE	/api/v1/forms/:id

List forms

You can return a list of your forms.

Argument	Options
query (string, optional)	Filter your forms by name, id, uuid (endpoint id), or project_id
page (integer, optional)	Change the page

Example API call

https://usebasin.com/api/v1/forms?filter_by=All&page=1&query=&api_token={account_api_token}

Note

Make sure you swap out {account_api_token} with your account wide API token found on your Account Settings page.

Show/Delete a form

You can return the attributes of a single form or delete a form using its id.

Argument	Options
id (integer)	The the form with this id

Example API call

https://usebasin.com/api/v1/forms/{form_id}?api_token={account_api_token}

Note

Make sure you swap out  {account_api_token}  with your account wide API token found on your Account Settings page.

Create/Update a form

The following attributes are available to you.

Attribute	Type	Notes
name	string
redirect_url	string	Available to Basic users and above.
use_ajax	boolean
notification_emails	string	Comma seperated list of email addresses used in the "To:" field
notification_cc_emails	string	Comma seperated list of email addresses used in the "Cc:" field
notification_bcc_emails	string	Comma seperated list of email addresses used in the \"Bcc:\" field. Available to Basic users and above.
whitelist_source_domains	string	Comma seperated list of domains to whitelist
force_recaptcha	boolean	If enabled the g-recaptcha-response is required with all your submissions. Note: Only one of force_recaptcha, force_hcaptcha, force_turnstilecan be true at one time.
force_hcaptcha	boolean	If enabled the h-captcha-response is required with all your submissions. Note: Only one of force_recaptcha, force_hcaptcha, force_turnstile can be true at one time.
force_turnstile	boolean	If enabled the turnstile-response is required with all your submissions. Note: Only one of force_recaptcha, force_hcaptcha, force_turnstile can be true at one time.
turnstile_site_key	string	The cloudflare turnstile site key.
turnstile_secret	string	The cloudflare turnstile secret key.
notification_subject	string	Subject of the notification email.
notification_from_name	string	From name for the notification email.
autoreply	boolean	Enable the auto response email
autoreply_body	text	Used to populate the body of Basin's default auto response template.
autoreply_subject	string
autoreply_from_name	string
autoreply_greeting	string
autoreply_name	string	The persons name that displays at the bottom of the default auto response email.
autoreply_title	string	The person's title which displays above their name in the default auto response template.
autoreply_email	string	The email that displays at the bottom of the default auto response template
button_background_color	string (css hex)	Override the default Basin themed emails.
button_text_color	string (css hex)	Override the default Basin themed emails.
data_receipt_email	boolean	Enable the data receipt email.
retention_days	integer	Amount of days to keep submission before deletion (default 1460)
hide_dashboard_button	boolean	Used to disable the "Open in Dashboard" button on the default Basin submission notification emails.
exclude_submitter_from_reply	boolean	Used to disabled the automatic reply-to email address on Basin's default notification email.
honeypot_field	string
recaptcha_failed_url	string
domain_id	integer	The custom domain id
domain_email	string	The email for use with the custom domain. Ex: jack@twitter.com
duplicate_filter	boolean	Enable to filter duplicate submissions within a brief time window.

Example API call

https://usebasin.com/api/v1/forms?api_token={account_api_token}
{\"form\":{\"name\":\"formname\",\...}}

Note

Make sure you swap out {account_api_token} with your account wide API token found on your Account Settings page.