Open API v2 / Forms / Forms
Forms
→
Every request needs a bearer token: Authorization: Bearer <token>. Base URL https://your-site.webinone.com. New to field types? See the type reference.
Retrieves a list of forms by using a "where" filtering
Parameters
Wherestring · query
JSON filter expression. Combine operators ($eq, $contains, $gt, $in, …) with $and / $or.
Order_Bystring · query
Sort field. Prefix with - for descending; comma-separate for tie-breakers.
Semantic_Querystring · query
Natural-language search, ranked by relevance.
Min_Scorenumber · query
Lowest relevance score to include when using Semantic_Query.
Offsetinteger · query
Number of items to skip before returning results. Defaults to 0.
Limitinteger · query
Maximum number of items to return. Defaults to 100.
Response
Idinteger
Unique identifier for the field definition in the database. Read-only.
Namestring · nullable
Public subfield name.
Aliasstring · nullable
Technical ID for the developer.
Typeenum
System (pre-defined fields like "Email") or Custom (manually added fields). Possible values: Generic, SingleItem, CheckOut, Recurring, Quote.Possible values: GenericSingleItemCheckOutRecurringQuote
IsSendConfirmEmailNotificationboolean
If true, sends a confirmation email to the admin upon submission.
IsSendSecureZoneLoginDetailsEmailboolean
Automatically sends login/password if the form registers a new user.
IsSecureSubmissionboolean
Encrypts or restricts the submission data for privacy compliance.
SubmissionFolderPathstring · nullable
Path to a folder on the internal CMS server (local storage). Used for standard file access via the admin panel or file explorer.
FtpPathstring · nullable
Path to external storage (FTP/SFTP server). Used to automatically transfer downloaded files to another server or backup platform. Read-only.
CreatedDateTimestring · date-time
The immutable date and time when the record was generated in the system. Read-only.
EnabledAutoresponderboolean
Activates or deactivates the automatic "Thank You" email sent to the user immediately after they submit the form.
Templatestring · nullable
The path or name of the Liquid/HTML file that controls the form's structure and styling (e.g., _layouts/contact-form.html).
RecurringTypeenum
For recurring forms, how often the associated payment or subscription repeats. Possible values: None, Daily, Weekly, Fortnightly, Monthly, Quarterly, HalfYearly, Yearly.Possible values: NoneDailyWeeklyFortnightlyMonthlyQuarterlyHalfYearlyYearly
EnableDefaultJSValidationboolean
If true, the system injects built-in JavaScript to validate fields before the POST.
SecureZoneIdsarray of integers
Lists the zones the user will be automatically added to after submission.
CustomWorkflowIdsarray of integers
Triggers specific backend processes (e.g., Lead sync to CRM).
FormFieldsarray of objects
A collection of objects that defines the structural building blocks of a form.
Idinteger
Unique identifier for the field definition in the database. Read-only.
IsMandatoryboolean
If true, the field becomes mandatory (validation required).
Namestring · nullable
Public subfield name.
Aliasstring · nullable
Technical ID for the developer.
IsEditableboolean · nullable
If false, the field is rendered as read-only or hidden from the user.
IsCompositeboolean · nullable
Structural Flag: If true, this field is a container for multiple sub-inputs (defined in the Properties array).
Typeenum
System (pre-defined fields like "Email") or Custom (manually added fields).Possible values: SystemCustomCustomCrmGroup
Propertiesarray of objects
A nested list of specific input elements (sub-fields) that belong to this FormField.
Namestring
Public subfield name.
Aliasstring
Technical ID for the developer.
Typeenum
System (pre-defined fields like "Email") or Custom (manually added fields). Possible values: DateTime, CheckboxList, DropdownList, ListboxList, RadioList, Multiline, String, Boolean, Recaptcha, Upload, Password, AcceptPayment, AcceptEventSubscription, IsDataUsingAllowed, Country, HiddenValidator.Possible values: DateTimeCheckboxListDropdownListListboxListRadioListMultilineStringBooleanRecaptchaUploadPasswordAcceptPaymentAcceptEventSubscriptionIsDataUsingAllowedCountryHiddenValidator
IsMandatoryboolean
If true, the field becomes mandatory (validation required).
Optionsarray of strings
Array of values for lists (Dropdown, Radio, CheckboxList).
FormAutoresponderobject
Defines the automated "Thank You" email sent to the user immediately after a successful form submission.
FromNamestring · nullable
The display name of the sender (e.g., "Support Team" or "Company Name").
FromEmailstring · nullable
The email address the response is sent from. Must be a valid email format.
Subjectstring · nullable
The email's subject line. Often supports Liquid placeholders like .
Bodystring · nullable
The main content of the email. Can contain plain text, HTML, or Liquid variables.
TemplateIdinteger
The ID of the global Email Design Template used to wrap the Body (header/footer).
EnableEditorboolean
If true, the Body, should be rendered in a WYSIWYG (Rich Text) editor in the admin panel.
curl "https://your-site.webinone.com/api/v2/admin/forms" \ -H "Authorization: Bearer <token>"
await fetch("https://your-site.webinone.com/api/v2/admin/forms", { method: "GET", headers: { "Authorization": "Bearer <token>" } });
import requests requests.get( "https://your-site.webinone.com/api/v2/admin/forms", headers={"Authorization": "Bearer <token>"} )
$client = new GuzzleHttp\Client(); $response = $client->request('GET', 'https://your-site.webinone.com/api/v2/admin/forms', [ 'headers' => [ 'Authorization' => 'Bearer <token>' ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Get, "https://your-site.webinone.com/api/v2/admin/forms"); request.Headers.Add("Authorization", "Bearer <token>"); var response = await client.SendAsync(request);
Response · 200
{
"Items": [
{
"Id": 1,
"Name": "Example",
"Alias": "string",
"Type": "Generic",
"IsSendConfirmEmailNotification": false,
"IsSendSecureZoneLoginDetailsEmail": false,
"IsSecureSubmission": false,
"SubmissionFolderPath": "string",
"FtpPath": "string",
"CreatedDateTime": "2026-07-01T00: 00: 00Z",
"EnabledAutoresponder": false,
"Template": "string",
"RecurringType": "None",
"EnableDefaultJSValidation": false,
"SecureZoneIds": [
0
],
"CustomWorkflowIds": [
0
],
"FormFields": [
{
"Id": 1,
"IsMandatory": false,
"Name": "Example",
"Alias": "string",
"IsEditable": false,
"IsComposite": false,
"Type": "System",
"Properties": [
{
"Name": "Example",
"Alias": "string",
"Type": "DateTime",
"IsMandatory": false,
"Options": null
}
]
}
],
"FormAutoresponder": {
"FromName": "Example",
"FromEmail": "user@example.com",
"Subject": "string",
"Body": "string",
"TemplateId": 1,
"EnableEditor": false
}
}
],
"TotalItemsCount": 0
}Creates a new form
Body parameters
Namestringrequired
Name of the form.
Aliasstringrequired
System reference for the form. Changing the alias will result in any existing references to the previous Form alias breaking.
Typeenum
Menu item type. Possible values: Generic, SingleItem, CheckOut, Recurring, Quote.Possible values: GenericSingleItemCheckOutRecurringQuote
RecurringTypeenum
Defines if this form/item repeats. Available for RecurringType = Recurring. Possible values: None, Daily, Weekly, Fortnightly, Monthly, Quarterly, HalfYearly, Yearly.Possible values: NoneDailyWeeklyFortnightlyMonthlyQuarterlyHalfYearlyYearly
FormFieldsarray of objectsrequired
The fields that make up the form, defining what inputs the visitor sees and fills in.
Namestring · nullable
Name of the form field.
Aliasstring · nullable
System reference for the form. Changing the alias will result in any existing references to the previous Form alias breaking.
IsEditableboolean · nullable
Whether the user can edit this field. When false it renders as read-only or hidden.
IsCompositeboolean · nullable
Whether the field is a container that groups several sub-inputs listed in Properties, rather than a single input.
Typeenum
Menu item type. Possible values: System, Custom, CustomCrmGroup.Possible values: SystemCustomCustomCrmGroup
Propertiesarray of objects
The sub-inputs that belong to this field, used when the field is composite.
Namestringrequired
Public subfield name.
Aliasstringrequired
Technical ID for the developer.
Typeenumrequired
System (pre-defined fields like "Email") or Custom (manually added fields). Possible values: DateTime, CheckboxList, DropdownList, ListboxList, RadioList, Multiline, String, Boolean, Recaptcha, Upload, Password, AcceptPayment, AcceptEventSubscription, IsDataUsingAllowed, Country, HiddenValidator.Possible values: DateTimeCheckboxListDropdownListListboxListRadioListMultilineStringBooleanRecaptchaUploadPasswordAcceptPaymentAcceptEventSubscriptionIsDataUsingAllowedCountryHiddenValidator
IsMandatoryboolean
If true, the field becomes mandatory (validation required).
Optionsarray of strings
Array of values for lists (Dropdown, Radio, CheckboxList).
Response
Idinteger
Unique identifier for the field definition in the database. Read-only.
Namestring · nullable
Public subfield name.
Aliasstring · nullable
Technical ID for the developer.
Typeenum
System (pre-defined fields like "Email") or Custom (manually added fields). Possible values: Generic, SingleItem, CheckOut, Recurring, Quote.Possible values: GenericSingleItemCheckOutRecurringQuote
IsSendConfirmEmailNotificationboolean
If true, sends a confirmation email to the admin upon submission.
IsSendSecureZoneLoginDetailsEmailboolean
Automatically sends login/password if the form registers a new user.
IsSecureSubmissionboolean
Encrypts or restricts the submission data for privacy compliance.
SubmissionFolderPathstring · nullable
Path to a folder on the internal CMS server (local storage). Used for standard file access via the admin panel or file explorer.
FtpPathstring · nullable
Path to external storage (FTP/SFTP server). Used to automatically transfer downloaded files to another server or backup platform. Read-only.
CreatedDateTimestring · date-time
The immutable date and time when the record was generated in the system. Read-only.
EnabledAutoresponderboolean
Activates or deactivates the automatic "Thank You" email sent to the user immediately after they submit the form.
Templatestring · nullable
The path or name of the Liquid/HTML file that controls the form's structure and styling (e.g., _layouts/contact-form.html).
RecurringTypeenum
For recurring forms, how often the associated payment or subscription repeats. Possible values: None, Daily, Weekly, Fortnightly, Monthly, Quarterly, HalfYearly, Yearly.Possible values: NoneDailyWeeklyFortnightlyMonthlyQuarterlyHalfYearlyYearly
EnableDefaultJSValidationboolean
If true, the system injects built-in JavaScript to validate fields before the POST.
SecureZoneIdsarray of integers
Lists the zones the user will be automatically added to after submission.
CustomWorkflowIdsarray of integers
Triggers specific backend processes (e.g., Lead sync to CRM).
FormFieldsarray of objects
A collection of objects that defines the structural building blocks of a form.
Idinteger
Unique identifier for the field definition in the database. Read-only.
IsMandatoryboolean
If true, the field becomes mandatory (validation required).
Namestring · nullable
Public subfield name.
Aliasstring · nullable
Technical ID for the developer.
IsEditableboolean · nullable
If false, the field is rendered as read-only or hidden from the user.
IsCompositeboolean · nullable
Structural Flag: If true, this field is a container for multiple sub-inputs (defined in the Properties array).
Typeenum
System (pre-defined fields like "Email") or Custom (manually added fields).Possible values: SystemCustomCustomCrmGroup
Propertiesarray of objects
A nested list of specific input elements (sub-fields) that belong to this FormField.
Namestring
Public subfield name.
Aliasstring
Technical ID for the developer.
Typeenum
System (pre-defined fields like "Email") or Custom (manually added fields). Possible values: DateTime, CheckboxList, DropdownList, ListboxList, RadioList, Multiline, String, Boolean, Recaptcha, Upload, Password, AcceptPayment, AcceptEventSubscription, IsDataUsingAllowed, Country, HiddenValidator.Possible values: DateTimeCheckboxListDropdownListListboxListRadioListMultilineStringBooleanRecaptchaUploadPasswordAcceptPaymentAcceptEventSubscriptionIsDataUsingAllowedCountryHiddenValidator
IsMandatoryboolean
If true, the field becomes mandatory (validation required).
Optionsarray of strings
Array of values for lists (Dropdown, Radio, CheckboxList).
FormAutoresponderobject
Defines the automated "Thank You" email sent to the user immediately after a successful form submission.
FromNamestring · nullable
The display name of the sender (e.g., "Support Team" or "Company Name").
FromEmailstring · nullable
The email address the response is sent from. Must be a valid email format.
Subjectstring · nullable
The email's subject line. Often supports Liquid placeholders like .
Bodystring · nullable
The main content of the email. Can contain plain text, HTML, or Liquid variables.
TemplateIdinteger
The ID of the global Email Design Template used to wrap the Body (header/footer).
EnableEditorboolean
If true, the Body, should be rendered in a WYSIWYG (Rich Text) editor in the admin panel.
curl -X POST "https://your-site.webinone.com/api/v2/admin/forms" \ -H "Authorization: Bearer <token>" \ -H "Content-Type: application/json" \ -d '{"Name":"Example","Alias":"string","Type":"Generic","RecurringType":"None","FormFields":[{"Name":"Example","Alias":"string","IsEditable":false,"IsComposite":false,"Type":"System","Properties":[{"Name":"Example","Alias":"string","Type":"DateTime","IsMandatory":false,"Options":["string"]}]}]}'
await fetch("https://your-site.webinone.com/api/v2/admin/forms", { method: "POST", headers: { "Authorization": "Bearer <token>", "Content-Type": "application/json" }, body: JSON.stringify({ "Name": "Example", "Alias": "string", "Type": "Generic", "RecurringType": "None", "FormFields": [ { "Name": "Example", "Alias": "string", "IsEditable": false, "IsComposite": false, "Type": "System", "Properties": [ { "Name": "Example", "Alias": "string", "Type": "DateTime", "IsMandatory": false, "Options": [ "string" ] } ] } ] }) });
import requests requests.post( "https://your-site.webinone.com/api/v2/admin/forms", headers={"Authorization": "Bearer <token>"}, json={ "Name": "Example", "Alias": "string", "Type": "Generic", "RecurringType": "None", "FormFields": [{ "Name": "Example", "Alias": "string", "IsEditable": False, "IsComposite": False, "Type": "System", "Properties": [{ "Name": "Example", "Alias": "string", "Type": "DateTime", "IsMandatory": False, "Options": ["string"] }] }] } )
$client = new GuzzleHttp\Client(); $response = $client->request('POST', 'https://your-site.webinone.com/api/v2/admin/forms', [ 'headers' => [ 'Authorization' => 'Bearer <token>', 'Content-Type' => 'application/json' ], 'json' => [ 'Name' => 'Example', 'Alias' => 'string', 'Type' => 'Generic', 'RecurringType' => 'None', 'FormFields' => [[ 'Name' => 'Example', 'Alias' => 'string', 'IsEditable' => false, 'IsComposite' => false, 'Type' => 'System', 'Properties' => [[ 'Name' => 'Example', 'Alias' => 'string', 'Type' => 'DateTime', 'IsMandatory' => false, 'Options' => ['string'] ]] ]] ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Post, "https://your-site.webinone.com/api/v2/admin/forms"); request.Headers.Add("Authorization", "Bearer <token>"); request.Content = new StringContent( "{\"Name\":\"Example\",\"Alias\":\"string\",\"Type\":\"Generic\",\"RecurringType\":\"None\",\"FormFields\":[{\"Name\":\"Example\",\"Alias\":\"string\",\"IsEditable\":false,\"IsComposite\":false,\"Type\":\"System\",\"Properties\":[{\"Name\":\"Example\",\"Alias\":\"string\",\"Type\":\"DateTime\",\"IsMandatory\":false,\"Options\":[\"string\"]}]}]}", Encoding.UTF8, "application/json"); var response = await client.SendAsync(request);
Response · 200
{
"Id": 1,
"Name": "Example",
"Alias": "string",
"Type": "Generic",
"IsSendConfirmEmailNotification": false,
"IsSendSecureZoneLoginDetailsEmail": false,
"IsSecureSubmission": false,
"SubmissionFolderPath": "string",
"FtpPath": "string",
"CreatedDateTime": "2026-07-01T00: 00: 00Z",
"EnabledAutoresponder": false,
"Template": "string",
"RecurringType": "None",
"EnableDefaultJSValidation": false,
"SecureZoneIds": [
0
],
"CustomWorkflowIds": [
0
],
"FormFields": [
{
"Id": 1,
"IsMandatory": false,
"Name": "Example",
"Alias": "string",
"IsEditable": false,
"IsComposite": false,
"Type": "System",
"Properties": [
{
"Name": "Example",
"Alias": "string",
"Type": "DateTime",
"IsMandatory": false,
"Options": [
"string"
]
}
]
}
],
"FormAutoresponder": {
"FromName": "Example",
"FromEmail": "user@example.com",
"Subject": "string",
"Body": "string",
"TemplateId": 1,
"EnableEditor": false
}
}Retrieves a single form
Parameters
idinteger · pathrequired
Form id.
Response
Idinteger
Unique identifier for the field definition in the database. Read-only.
Namestring · nullable
Public subfield name.
Aliasstring · nullable
Technical ID for the developer.
Typeenum
System (pre-defined fields like "Email") or Custom (manually added fields). Possible values: Generic, SingleItem, CheckOut, Recurring, Quote.Possible values: GenericSingleItemCheckOutRecurringQuote
IsSendConfirmEmailNotificationboolean
If true, sends a confirmation email to the admin upon submission.
IsSendSecureZoneLoginDetailsEmailboolean
Automatically sends login/password if the form registers a new user.
IsSecureSubmissionboolean
Encrypts or restricts the submission data for privacy compliance.
SubmissionFolderPathstring · nullable
Path to a folder on the internal CMS server (local storage). Used for standard file access via the admin panel or file explorer.
FtpPathstring · nullable
Path to external storage (FTP/SFTP server). Used to automatically transfer downloaded files to another server or backup platform. Read-only.
CreatedDateTimestring · date-time
The immutable date and time when the record was generated in the system. Read-only.
EnabledAutoresponderboolean
Activates or deactivates the automatic "Thank You" email sent to the user immediately after they submit the form.
Templatestring · nullable
The path or name of the Liquid/HTML file that controls the form's structure and styling (e.g., _layouts/contact-form.html).
RecurringTypeenum
For recurring forms, how often the associated payment or subscription repeats. Possible values: None, Daily, Weekly, Fortnightly, Monthly, Quarterly, HalfYearly, Yearly.Possible values: NoneDailyWeeklyFortnightlyMonthlyQuarterlyHalfYearlyYearly
EnableDefaultJSValidationboolean
If true, the system injects built-in JavaScript to validate fields before the POST.
SecureZoneIdsarray of integers
Lists the zones the user will be automatically added to after submission.
CustomWorkflowIdsarray of integers
Triggers specific backend processes (e.g., Lead sync to CRM).
FormFieldsarray of objects
A collection of objects that defines the structural building blocks of a form.
Idinteger
Unique identifier for the field definition in the database. Read-only.
IsMandatoryboolean
If true, the field becomes mandatory (validation required).
Namestring · nullable
Public subfield name.
Aliasstring · nullable
Technical ID for the developer.
IsEditableboolean · nullable
If false, the field is rendered as read-only or hidden from the user.
IsCompositeboolean · nullable
Structural Flag: If true, this field is a container for multiple sub-inputs (defined in the Properties array).
Typeenum
System (pre-defined fields like "Email") or Custom (manually added fields).Possible values: SystemCustomCustomCrmGroup
Propertiesarray of objects
A nested list of specific input elements (sub-fields) that belong to this FormField.
Namestring
Public subfield name.
Aliasstring
Technical ID for the developer.
Typeenum
System (pre-defined fields like "Email") or Custom (manually added fields). Possible values: DateTime, CheckboxList, DropdownList, ListboxList, RadioList, Multiline, String, Boolean, Recaptcha, Upload, Password, AcceptPayment, AcceptEventSubscription, IsDataUsingAllowed, Country, HiddenValidator.Possible values: DateTimeCheckboxListDropdownListListboxListRadioListMultilineStringBooleanRecaptchaUploadPasswordAcceptPaymentAcceptEventSubscriptionIsDataUsingAllowedCountryHiddenValidator
IsMandatoryboolean
If true, the field becomes mandatory (validation required).
Optionsarray of strings
Array of values for lists (Dropdown, Radio, CheckboxList).
FormAutoresponderobject
Defines the automated "Thank You" email sent to the user immediately after a successful form submission.
FromNamestring · nullable
The display name of the sender (e.g., "Support Team" or "Company Name").
FromEmailstring · nullable
The email address the response is sent from. Must be a valid email format.
Subjectstring · nullable
The email's subject line. Often supports Liquid placeholders like .
Bodystring · nullable
The main content of the email. Can contain plain text, HTML, or Liquid variables.
TemplateIdinteger
The ID of the global Email Design Template used to wrap the Body (header/footer).
EnableEditorboolean
If true, the Body, should be rendered in a WYSIWYG (Rich Text) editor in the admin panel.
curl "https://your-site.webinone.com/api/v2/admin/forms/1" \ -H "Authorization: Bearer <token>"
await fetch("https://your-site.webinone.com/api/v2/admin/forms/1", { method: "GET", headers: { "Authorization": "Bearer <token>" } });
import requests requests.get( "https://your-site.webinone.com/api/v2/admin/forms/1", headers={"Authorization": "Bearer <token>"} )
$client = new GuzzleHttp\Client(); $response = $client->request('GET', 'https://your-site.webinone.com/api/v2/admin/forms/1', [ 'headers' => [ 'Authorization' => 'Bearer <token>' ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Get, "https://your-site.webinone.com/api/v2/admin/forms/1"); request.Headers.Add("Authorization", "Bearer <token>"); var response = await client.SendAsync(request);
Response · 200
{
"Id": 1,
"Name": "Example",
"Alias": "string",
"Type": "Generic",
"IsSendConfirmEmailNotification": false,
"IsSendSecureZoneLoginDetailsEmail": false,
"IsSecureSubmission": false,
"SubmissionFolderPath": "string",
"FtpPath": "string",
"CreatedDateTime": "2026-07-01T00: 00: 00Z",
"EnabledAutoresponder": false,
"Template": "string",
"RecurringType": "None",
"EnableDefaultJSValidation": false,
"SecureZoneIds": [
0
],
"CustomWorkflowIds": [
0
],
"FormFields": [
{
"Id": 1,
"IsMandatory": false,
"Name": "Example",
"Alias": "string",
"IsEditable": false,
"IsComposite": false,
"Type": "System",
"Properties": [
{
"Name": "Example",
"Alias": "string",
"Type": "DateTime",
"IsMandatory": false,
"Options": [
"string"
]
}
]
}
],
"FormAutoresponder": {
"FromName": "Example",
"FromEmail": "user@example.com",
"Subject": "string",
"Body": "string",
"TemplateId": 1,
"EnableEditor": false
}
}Updates an existing form fields
Parameters
idinteger · pathrequired
Form id.
Body parameters
Namestringrequired
Name of the form.
Aliasstringrequired
System reference for the form. Changing the alias will result in any existing references to the previous Form alias breaking.
Typeenum
Menu item type. Possible values: Generic, SingleItem, CheckOut, Recurring, Quote.Possible values: GenericSingleItemCheckOutRecurringQuote
RecurringTypeenum
Defines if this form/item repeats. Available for RecurringType = Recurring. Possible values: None, Daily, Weekly, Fortnightly, Monthly, Quarterly, HalfYearly, Yearly.Possible values: NoneDailyWeeklyFortnightlyMonthlyQuarterlyHalfYearlyYearly
FormFieldsarray of objectsrequired
The full set of fields to save for the form, replacing the existing field layout on update.
Idinteger
Unique identifier for the field definition in the database. Read-only.
IsMandatoryboolean
If true, the field becomes mandatory (validation required).
Namestring · nullable
Public subfield name.
Aliasstring · nullable
Technical ID for the developer.
IsEditableboolean · nullable
If false, the field is rendered as read-only or hidden from the user.
IsCompositeboolean · nullable
Structural Flag: If true, this field is a container for multiple sub-inputs (defined in the Properties array).
Typeenum
System (pre-defined fields like "Email") or Custom (manually added fields).Possible values: SystemCustomCustomCrmGroup
Propertiesarray of objects
A nested list of specific input elements (sub-fields) that belong to this FormField.
Namestringrequired
Public subfield name.
Aliasstringrequired
Technical ID for the developer.
Typeenumrequired
System (pre-defined fields like "Email") or Custom (manually added fields). Possible values: DateTime, CheckboxList, DropdownList, ListboxList, RadioList, Multiline, String, Boolean, Recaptcha, Upload, Password, AcceptPayment, AcceptEventSubscription, IsDataUsingAllowed, Country, HiddenValidator.Possible values: DateTimeCheckboxListDropdownListListboxListRadioListMultilineStringBooleanRecaptchaUploadPasswordAcceptPaymentAcceptEventSubscriptionIsDataUsingAllowedCountryHiddenValidator
IsMandatoryboolean
If true, the field becomes mandatory (validation required).
Optionsarray of strings
Array of values for lists (Dropdown, Radio, CheckboxList).
Response
Idinteger
Unique identifier for the field definition in the database. Read-only.
Namestring · nullable
Public subfield name.
Aliasstring · nullable
Technical ID for the developer.
Typeenum
System (pre-defined fields like "Email") or Custom (manually added fields). Possible values: Generic, SingleItem, CheckOut, Recurring, Quote.Possible values: GenericSingleItemCheckOutRecurringQuote
IsSendConfirmEmailNotificationboolean
If true, sends a confirmation email to the admin upon submission.
IsSendSecureZoneLoginDetailsEmailboolean
Automatically sends login/password if the form registers a new user.
IsSecureSubmissionboolean
Encrypts or restricts the submission data for privacy compliance.
SubmissionFolderPathstring · nullable
Path to a folder on the internal CMS server (local storage). Used for standard file access via the admin panel or file explorer.
FtpPathstring · nullable
Path to external storage (FTP/SFTP server). Used to automatically transfer downloaded files to another server or backup platform. Read-only.
CreatedDateTimestring · date-time
The immutable date and time when the record was generated in the system. Read-only.
EnabledAutoresponderboolean
Activates or deactivates the automatic "Thank You" email sent to the user immediately after they submit the form.
Templatestring · nullable
The path or name of the Liquid/HTML file that controls the form's structure and styling (e.g., _layouts/contact-form.html).
RecurringTypeenum
For recurring forms, how often the associated payment or subscription repeats. Possible values: None, Daily, Weekly, Fortnightly, Monthly, Quarterly, HalfYearly, Yearly.Possible values: NoneDailyWeeklyFortnightlyMonthlyQuarterlyHalfYearlyYearly
EnableDefaultJSValidationboolean
If true, the system injects built-in JavaScript to validate fields before the POST.
SecureZoneIdsarray of integers
Lists the zones the user will be automatically added to after submission.
CustomWorkflowIdsarray of integers
Triggers specific backend processes (e.g., Lead sync to CRM).
FormFieldsarray of objects
A collection of objects that defines the structural building blocks of a form.
Idinteger
Unique identifier for the field definition in the database. Read-only.
IsMandatoryboolean
If true, the field becomes mandatory (validation required).
Namestring · nullable
Public subfield name.
Aliasstring · nullable
Technical ID for the developer.
IsEditableboolean · nullable
If false, the field is rendered as read-only or hidden from the user.
IsCompositeboolean · nullable
Structural Flag: If true, this field is a container for multiple sub-inputs (defined in the Properties array).
Typeenum
System (pre-defined fields like "Email") or Custom (manually added fields).Possible values: SystemCustomCustomCrmGroup
Propertiesarray of objects
A nested list of specific input elements (sub-fields) that belong to this FormField.
Namestring
Public subfield name.
Aliasstring
Technical ID for the developer.
Typeenum
System (pre-defined fields like "Email") or Custom (manually added fields). Possible values: DateTime, CheckboxList, DropdownList, ListboxList, RadioList, Multiline, String, Boolean, Recaptcha, Upload, Password, AcceptPayment, AcceptEventSubscription, IsDataUsingAllowed, Country, HiddenValidator.Possible values: DateTimeCheckboxListDropdownListListboxListRadioListMultilineStringBooleanRecaptchaUploadPasswordAcceptPaymentAcceptEventSubscriptionIsDataUsingAllowedCountryHiddenValidator
IsMandatoryboolean
If true, the field becomes mandatory (validation required).
Optionsarray of strings
Array of values for lists (Dropdown, Radio, CheckboxList).
FormAutoresponderobject
Defines the automated "Thank You" email sent to the user immediately after a successful form submission.
FromNamestring · nullable
The display name of the sender (e.g., "Support Team" or "Company Name").
FromEmailstring · nullable
The email address the response is sent from. Must be a valid email format.
Subjectstring · nullable
The email's subject line. Often supports Liquid placeholders like .
Bodystring · nullable
The main content of the email. Can contain plain text, HTML, or Liquid variables.
TemplateIdinteger
The ID of the global Email Design Template used to wrap the Body (header/footer).
EnableEditorboolean
If true, the Body, should be rendered in a WYSIWYG (Rich Text) editor in the admin panel.
curl -X PUT "https://your-site.webinone.com/api/v2/admin/forms/1" \ -H "Authorization: Bearer <token>" \ -H "Content-Type: application/json" \ -d '{"Name":"Example","Alias":"string","Type":"Generic","RecurringType":"None","FormFields":[{"Id":1,"IsMandatory":false,"Name":"Example","Alias":"string","IsEditable":false,"IsComposite":false,"Type":"System","Properties":[{"Name":"Example","Alias":"string","Type":"DateTime","IsMandatory":false,"Options":["string"]}]}]}'
await fetch("https://your-site.webinone.com/api/v2/admin/forms/1", { method: "PUT", headers: { "Authorization": "Bearer <token>", "Content-Type": "application/json" }, body: JSON.stringify({ "Name": "Example", "Alias": "string", "Type": "Generic", "RecurringType": "None", "FormFields": [ { "Id": 1, "IsMandatory": false, "Name": "Example", "Alias": "string", "IsEditable": false, "IsComposite": false, "Type": "System", "Properties": [ { "Name": "Example", "Alias": "string", "Type": "DateTime", "IsMandatory": false, "Options": [ "string" ] } ] } ] }) });
import requests requests.put( "https://your-site.webinone.com/api/v2/admin/forms/1", headers={"Authorization": "Bearer <token>"}, json={ "Name": "Example", "Alias": "string", "Type": "Generic", "RecurringType": "None", "FormFields": [{ "Id": 1, "IsMandatory": False, "Name": "Example", "Alias": "string", "IsEditable": False, "IsComposite": False, "Type": "System", "Properties": [{ "Name": "Example", "Alias": "string", "Type": "DateTime", "IsMandatory": False, "Options": ["string"] }] }] } )
$client = new GuzzleHttp\Client(); $response = $client->request('PUT', 'https://your-site.webinone.com/api/v2/admin/forms/1', [ 'headers' => [ 'Authorization' => 'Bearer <token>', 'Content-Type' => 'application/json' ], 'json' => [ 'Name' => 'Example', 'Alias' => 'string', 'Type' => 'Generic', 'RecurringType' => 'None', 'FormFields' => [[ 'Id' => 1, 'IsMandatory' => false, 'Name' => 'Example', 'Alias' => 'string', 'IsEditable' => false, 'IsComposite' => false, 'Type' => 'System', 'Properties' => [[ 'Name' => 'Example', 'Alias' => 'string', 'Type' => 'DateTime', 'IsMandatory' => false, 'Options' => ['string'] ]] ]] ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Put, "https://your-site.webinone.com/api/v2/admin/forms/1"); request.Headers.Add("Authorization", "Bearer <token>"); request.Content = new StringContent( "{\"Name\":\"Example\",\"Alias\":\"string\",\"Type\":\"Generic\",\"RecurringType\":\"None\",\"FormFields\":[{\"Id\":1,\"IsMandatory\":false,\"Name\":\"Example\",\"Alias\":\"string\",\"IsEditable\":false,\"IsComposite\":false,\"Type\":\"System\",\"Properties\":[{\"Name\":\"Example\",\"Alias\":\"string\",\"Type\":\"DateTime\",\"IsMandatory\":false,\"Options\":[\"string\"]}]}]}", Encoding.UTF8, "application/json"); var response = await client.SendAsync(request);
Response · 200
{
"Id": 1,
"Name": "Example",
"Alias": "string",
"Type": "Generic",
"IsSendConfirmEmailNotification": false,
"IsSendSecureZoneLoginDetailsEmail": false,
"IsSecureSubmission": false,
"SubmissionFolderPath": "string",
"FtpPath": "string",
"CreatedDateTime": "2026-07-01T00: 00: 00Z",
"EnabledAutoresponder": false,
"Template": "string",
"RecurringType": "None",
"EnableDefaultJSValidation": false,
"SecureZoneIds": [
0
],
"CustomWorkflowIds": [
0
],
"FormFields": [
{
"Id": 1,
"IsMandatory": false,
"Name": "Example",
"Alias": "string",
"IsEditable": false,
"IsComposite": false,
"Type": "System",
"Properties": [
{
"Name": "Example",
"Alias": "string",
"Type": "DateTime",
"IsMandatory": false,
"Options": [
"string"
]
}
]
}
],
"FormAutoresponder": {
"FromName": "Example",
"FromEmail": "user@example.com",
"Subject": "string",
"Body": "string",
"TemplateId": 1,
"EnableEditor": false
}
}Deletes an existing form
Parameters
idinteger · pathrequired
Resource identifier.
curl -X DELETE "https://your-site.webinone.com/api/v2/admin/forms/1" \ -H "Authorization: Bearer <token>"
await fetch("https://your-site.webinone.com/api/v2/admin/forms/1", { method: "DELETE", headers: { "Authorization": "Bearer <token>" } });
import requests requests.delete( "https://your-site.webinone.com/api/v2/admin/forms/1", headers={"Authorization": "Bearer <token>"} )
$client = new GuzzleHttp\Client(); $response = $client->request('DELETE', 'https://your-site.webinone.com/api/v2/admin/forms/1', [ 'headers' => [ 'Authorization' => 'Bearer <token>' ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Delete, "https://your-site.webinone.com/api/v2/admin/forms/1"); request.Headers.Add("Authorization", "Bearer <token>"); var response = await client.SendAsync(request);
Generate form template
Parameters
idstring · pathrequired
Resource identifier.
Response
curl -X POST "https://your-site.webinone.com/api/v2/admin/forms/1/generate-template" \ -H "Authorization: Bearer <token>"
await fetch("https://your-site.webinone.com/api/v2/admin/forms/1/generate-template", { method: "POST", headers: { "Authorization": "Bearer <token>" } });
import requests requests.post( "https://your-site.webinone.com/api/v2/admin/forms/1/generate-template", headers={"Authorization": "Bearer <token>"} )
$client = new GuzzleHttp\Client(); $response = $client->request('POST', 'https://your-site.webinone.com/api/v2/admin/forms/1/generate-template', [ 'headers' => [ 'Authorization' => 'Bearer <token>' ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Post, "https://your-site.webinone.com/api/v2/admin/forms/1/generate-template"); request.Headers.Add("Authorization", "Bearer <token>"); var response = await client.SendAsync(request);
Response · 200
"string"
Retrieves a form settings
Parameters
idstring · pathrequired
Resource identifier.
Response
IsEnabledboolean
Whether the form's autoresponder or notification settings block is active.
FromNamestring · nullable
The display name of the sender (e.g., "Support Team" or "Company Name").
FromEmailstring · nullable
The email address the response is sent from. Must be a valid email format.
Subjectstring · nullable
The email's subject line. Often supports Liquid placeholders like .
EnableEditorboolean
If true, the Body, should be rendered in a WYSIWYG (Rich Text) editor in the admin panel.
EnableDefaultJSValidationboolean
If true, the system injects built-in JavaScript to validate fields before the POST.
Bodystring · nullable
The main content of the email. Can contain plain text, HTML, or Liquid variables.
TemplateIdinteger · nullable
The ID of the global Email Design Template used to wrap the Body (header/footer).
IsSecureSubmissionboolean
Encrypts or restricts the submission data for privacy compliance.
SubmissionFolderPathstring · nullable
Path to a folder on the internal CMS server (local storage). Used for standard file access via the admin panel or file explorer.
CustomWorkflowIdsarray of integers
Triggers specific backend processes (e.g., Lead sync to CRM).
SecureZoneIdsarray of integers
Lists the zones the user will be automatically added to after submission.
IsSendSecureZoneLoginDetailsEmailboolean
Automatically sends login/password if the form registers a new user.
IsSendConfirmEmailNotificationboolean
If true, sends a confirmation email to the admin upon submission.
curl "https://your-site.webinone.com/api/v2/admin/forms/1/settings" \ -H "Authorization: Bearer <token>"
await fetch("https://your-site.webinone.com/api/v2/admin/forms/1/settings", { method: "GET", headers: { "Authorization": "Bearer <token>" } });
import requests requests.get( "https://your-site.webinone.com/api/v2/admin/forms/1/settings", headers={"Authorization": "Bearer <token>"} )
$client = new GuzzleHttp\Client(); $response = $client->request('GET', 'https://your-site.webinone.com/api/v2/admin/forms/1/settings', [ 'headers' => [ 'Authorization' => 'Bearer <token>' ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Get, "https://your-site.webinone.com/api/v2/admin/forms/1/settings"); request.Headers.Add("Authorization", "Bearer <token>"); var response = await client.SendAsync(request);
Response · 200
{
"IsEnabled": false,
"FromName": "Example",
"FromEmail": "user@example.com",
"Subject": "string",
"EnableEditor": false,
"EnableDefaultJSValidation": false,
"Body": "string",
"TemplateId": 1,
"IsSecureSubmission": false,
"SubmissionFolderPath": "string",
"CustomWorkflowIds": [
0
],
"SecureZoneIds": [
0
],
"IsSendSecureZoneLoginDetailsEmail": false,
"IsSendConfirmEmailNotification": false
}Update a form settings
Parameters
idstring · pathrequired
Resource identifier.
Body parameters
IsEnabledboolean
Whether the form's autoresponder or notification settings block is active.
FromNamestring · nullable
The display name of the sender (e.g., "Support Team" or "Company Name").
FromEmailstring · nullable
The email address the response is sent from. Must be a valid email format.
Subjectstring · nullable
The email's subject line. Often supports Liquid placeholders like .
EnableEditorboolean
If true, the Body, should be rendered in a WYSIWYG (Rich Text) editor in the admin panel.
EnableDefaultJSValidationboolean
If true, the system injects built-in JavaScript to validate fields before the POST.
Bodystring · nullable
The main content of the email. Can contain plain text, HTML, or Liquid variables.
TemplateIdinteger · nullable
The ID of the global Email Design Template used to wrap the Body (header/footer).
IsSecureSubmissionboolean
Encrypts or restricts the submission data for privacy compliance.
SubmissionFolderPathstring · nullable
Path to a folder on the internal CMS server (local storage). Used for standard file access via the admin panel or file explorer.
CustomWorkflowIdsarray of integers
Triggers specific backend processes (e.g., Lead sync to CRM).
SecureZoneIdsarray of integers
Lists the zones the user will be automatically added to after submission.
IsSendSecureZoneLoginDetailsEmailboolean
Automatically sends login/password if the form registers a new user.
IsSendConfirmEmailNotificationboolean
If true, sends a confirmation email to the admin upon submission.
Response
IsEnabledboolean
Whether the form's autoresponder or notification settings block is active.
FromNamestring · nullable
The display name of the sender (e.g., "Support Team" or "Company Name").
FromEmailstring · nullable
The email address the response is sent from. Must be a valid email format.
Subjectstring · nullable
The email's subject line. Often supports Liquid placeholders like .
EnableEditorboolean
If true, the Body, should be rendered in a WYSIWYG (Rich Text) editor in the admin panel.
EnableDefaultJSValidationboolean
If true, the system injects built-in JavaScript to validate fields before the POST.
Bodystring · nullable
The main content of the email. Can contain plain text, HTML, or Liquid variables.
TemplateIdinteger · nullable
The ID of the global Email Design Template used to wrap the Body (header/footer).
IsSecureSubmissionboolean
Encrypts or restricts the submission data for privacy compliance.
SubmissionFolderPathstring · nullable
Path to a folder on the internal CMS server (local storage). Used for standard file access via the admin panel or file explorer.
CustomWorkflowIdsarray of integers
Triggers specific backend processes (e.g., Lead sync to CRM).
SecureZoneIdsarray of integers
Lists the zones the user will be automatically added to after submission.
IsSendSecureZoneLoginDetailsEmailboolean
Automatically sends login/password if the form registers a new user.
IsSendConfirmEmailNotificationboolean
If true, sends a confirmation email to the admin upon submission.
curl -X PUT "https://your-site.webinone.com/api/v2/admin/forms/1/settings" \ -H "Authorization: Bearer <token>" \ -H "Content-Type: application/json" \ -d '{"IsEnabled":false,"FromName":"Example","FromEmail":"user@example.com","Subject":"string","EnableEditor":false,"EnableDefaultJSValidation":false,"Body":"string","TemplateId":1,"IsSecureSubmission":false,"SubmissionFolderPath":"string","CustomWorkflowIds":[0],"SecureZoneIds":[0],"IsSendSecureZoneLoginDetailsEmail":false,"IsSendConfirmEmailNotification":false}'
await fetch("https://your-site.webinone.com/api/v2/admin/forms/1/settings", { method: "PUT", headers: { "Authorization": "Bearer <token>", "Content-Type": "application/json" }, body: JSON.stringify({ "IsEnabled": false, "FromName": "Example", "FromEmail": "user@example.com", "Subject": "string", "EnableEditor": false, "EnableDefaultJSValidation": false, "Body": "string", "TemplateId": 1, "IsSecureSubmission": false, "SubmissionFolderPath": "string", "CustomWorkflowIds": [ 0 ], "SecureZoneIds": [ 0 ], "IsSendSecureZoneLoginDetailsEmail": false, "IsSendConfirmEmailNotification": false }) });
import requests requests.put( "https://your-site.webinone.com/api/v2/admin/forms/1/settings", headers={"Authorization": "Bearer <token>"}, json={ "IsEnabled": False, "FromName": "Example", "FromEmail": "user@example.com", "Subject": "string", "EnableEditor": False, "EnableDefaultJSValidation": False, "Body": "string", "TemplateId": 1, "IsSecureSubmission": False, "SubmissionFolderPath": "string", "CustomWorkflowIds": [0], "SecureZoneIds": [0], "IsSendSecureZoneLoginDetailsEmail": False, "IsSendConfirmEmailNotification": False } )
$client = new GuzzleHttp\Client(); $response = $client->request('PUT', 'https://your-site.webinone.com/api/v2/admin/forms/1/settings', [ 'headers' => [ 'Authorization' => 'Bearer <token>', 'Content-Type' => 'application/json' ], 'json' => [ 'IsEnabled' => false, 'FromName' => 'Example', 'FromEmail' => 'user@example.com', 'Subject' => 'string', 'EnableEditor' => false, 'EnableDefaultJSValidation' => false, 'Body' => 'string', 'TemplateId' => 1, 'IsSecureSubmission' => false, 'SubmissionFolderPath' => 'string', 'CustomWorkflowIds' => [0], 'SecureZoneIds' => [0], 'IsSendSecureZoneLoginDetailsEmail' => false, 'IsSendConfirmEmailNotification' => false ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Put, "https://your-site.webinone.com/api/v2/admin/forms/1/settings"); request.Headers.Add("Authorization", "Bearer <token>"); request.Content = new StringContent( "{\"IsEnabled\":false,\"FromName\":\"Example\",\"FromEmail\":\"user@example.com\",\"Subject\":\"string\",\"EnableEditor\":false,\"EnableDefaultJSValidation\":false,\"Body\":\"string\",\"TemplateId\":1,\"IsSecureSubmission\":false,\"SubmissionFolderPath\":\"string\",\"CustomWorkflowIds\":[0],\"SecureZoneIds\":[0],\"IsSendSecureZoneLoginDetailsEmail\":false,\"IsSendConfirmEmailNotification\":false}", Encoding.UTF8, "application/json"); var response = await client.SendAsync(request);
Response · 200
{
"IsEnabled": false,
"FromName": "Example",
"FromEmail": "user@example.com",
"Subject": "string",
"EnableEditor": false,
"EnableDefaultJSValidation": false,
"Body": "string",
"TemplateId": 1,
"IsSecureSubmission": false,
"SubmissionFolderPath": "string",
"CustomWorkflowIds": [
0
],
"SecureZoneIds": [
0
],
"IsSendSecureZoneLoginDetailsEmail": false,
"IsSendConfirmEmailNotification": false
}Retrieves a single form template
Parameters
idinteger · pathrequired
Resource identifier.
Response
curl "https://your-site.webinone.com/api/v2/admin/forms/1/template" \ -H "Authorization: Bearer <token>"
await fetch("https://your-site.webinone.com/api/v2/admin/forms/1/template", { method: "GET", headers: { "Authorization": "Bearer <token>" } });
import requests requests.get( "https://your-site.webinone.com/api/v2/admin/forms/1/template", headers={"Authorization": "Bearer <token>"} )
$client = new GuzzleHttp\Client(); $response = $client->request('GET', 'https://your-site.webinone.com/api/v2/admin/forms/1/template', [ 'headers' => [ 'Authorization' => 'Bearer <token>' ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Get, "https://your-site.webinone.com/api/v2/admin/forms/1/template"); request.Headers.Add("Authorization", "Bearer <token>"); var response = await client.SendAsync(request);
Response · 200
"string"
Updates an existing form template
Parameters
idstring · pathrequired
Resource identifier.
Body parameters
Templatestringrequired
The Liquid/HTML template file that controls the form's markup and styling.
curl -X PUT "https://your-site.webinone.com/api/v2/admin/forms/1/template" \ -H "Authorization: Bearer <token>" \ -H "Content-Type: application/json" \ -d '{"Template":"string"}'
await fetch("https://your-site.webinone.com/api/v2/admin/forms/1/template", { method: "PUT", headers: { "Authorization": "Bearer <token>", "Content-Type": "application/json" }, body: JSON.stringify({ "Template": "string" }) });
import requests requests.put( "https://your-site.webinone.com/api/v2/admin/forms/1/template", headers={"Authorization": "Bearer <token>"}, json={ "Template": "string" } )
$client = new GuzzleHttp\Client(); $response = $client->request('PUT', 'https://your-site.webinone.com/api/v2/admin/forms/1/template', [ 'headers' => [ 'Authorization' => 'Bearer <token>', 'Content-Type' => 'application/json' ], 'json' => [ 'Template' => 'string' ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Put, "https://your-site.webinone.com/api/v2/admin/forms/1/template"); request.Headers.Add("Authorization", "Bearer <token>"); request.Content = new StringContent( "{\"Template\":\"string\"}", Encoding.UTF8, "application/json"); var response = await client.SendAsync(request);
Retrieves a single forms field groups
Parameters
formTypestring · query
FormType.
includeCustomPropertiesboolean · query
IncludeCustomProperties.
Response
GroupNamestring · nullable
The display name of a group that bundles related fields together in the form layout.
Fieldsarray of objects
The fields that belong to this group.
Namestring · nullable
Public subfield name.
Aliasstring · nullable
Technical ID for the developer.
IsEditableboolean · nullable
If false, the field is rendered as read-only or hidden from the user.
IsCompositeboolean · nullable
Structural Flag: If true, this field is a container for multiple sub-inputs (defined in the Properties array).
GroupTypeenum
Where the field's group originates from, which determines how it is managed. Possible values: System, Custom, CustomCrmGroup.Possible values: SystemCustomCustomCrmGroup
Propertiesarray of objects
A nested list of specific input elements (sub-fields) that belong to this FormField.
Namestring · nullable
Public subfield name.
Aliasstring · nullable
Technical ID for the developer.
Typeenum
System (pre-defined fields like "Email") or Custom (manually added fields). Possible values: DateTime, CheckboxList, DropdownList, ListboxList, RadioList, Multiline, String, Boolean, Recaptcha, Upload, Password, AcceptPayment, AcceptEventSubscription, IsDataUsingAllowed, Country, HiddenValidator.Possible values: DateTimeCheckboxListDropdownListListboxListRadioListMultilineStringBooleanRecaptchaUploadPasswordAcceptPaymentAcceptEventSubscriptionIsDataUsingAllowedCountryHiddenValidator
IsMandatoryboolean · nullable
If true, the field becomes mandatory (validation required).
Optionsarray of strings
Array of values for lists (Dropdown, Radio, CheckboxList).
curl "https://your-site.webinone.com/api/v2/admin/forms/field-groups" \ -H "Authorization: Bearer <token>"
await fetch("https://your-site.webinone.com/api/v2/admin/forms/field-groups", { method: "GET", headers: { "Authorization": "Bearer <token>" } });
import requests requests.get( "https://your-site.webinone.com/api/v2/admin/forms/field-groups", headers={"Authorization": "Bearer <token>"} )
$client = new GuzzleHttp\Client(); $response = $client->request('GET', 'https://your-site.webinone.com/api/v2/admin/forms/field-groups', [ 'headers' => [ 'Authorization' => 'Bearer <token>' ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Get, "https://your-site.webinone.com/api/v2/admin/forms/field-groups"); request.Headers.Add("Authorization", "Bearer <token>"); var response = await client.SendAsync(request);
Response · 200
[
{
"GroupName": "Example",
"Fields": [
{
"Name": "Example",
"Alias": "string",
"IsEditable": false,
"IsComposite": false,
"GroupType": "System",
"Properties": [
{
"Name": "Example",
"Alias": "string",
"Type": "DateTime",
"IsMandatory": false,
"Options": [
null
]
}
]
}
]
}
]Retrieves a single forms field types
Response
curl "https://your-site.webinone.com/api/v2/admin/forms/field-types" \ -H "Authorization: Bearer <token>"
await fetch("https://your-site.webinone.com/api/v2/admin/forms/field-types", { method: "GET", headers: { "Authorization": "Bearer <token>" } });
import requests requests.get( "https://your-site.webinone.com/api/v2/admin/forms/field-types", headers={"Authorization": "Bearer <token>"} )
$client = new GuzzleHttp\Client(); $response = $client->request('GET', 'https://your-site.webinone.com/api/v2/admin/forms/field-types', [ 'headers' => [ 'Authorization' => 'Bearer <token>' ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Get, "https://your-site.webinone.com/api/v2/admin/forms/field-types"); request.Headers.Add("Authorization", "Bearer <token>"); var response = await client.SendAsync(request);
Response · 200
[ "string" ]
Retrieves a single forms recurring types
Response
AccessTypeenum
The billing interval this payment option represents, from daily through yearly. None means no recurring interval is set.Possible values: NoneDailyWeeklyFortnightlyMonthlyQuarterlyHalfYearlyYearly
IsEnableboolean
Whether this billing interval is available for selection.
DisplayNamestring · nullable
Display name of the payment interval state, shown to users.
curl "https://your-site.webinone.com/api/v2/admin/forms/recurring-types" \ -H "Authorization: Bearer <token>"
await fetch("https://your-site.webinone.com/api/v2/admin/forms/recurring-types", { method: "GET", headers: { "Authorization": "Bearer <token>" } });
import requests requests.get( "https://your-site.webinone.com/api/v2/admin/forms/recurring-types", headers={"Authorization": "Bearer <token>"} )
$client = new GuzzleHttp\Client(); $response = $client->request('GET', 'https://your-site.webinone.com/api/v2/admin/forms/recurring-types', [ 'headers' => [ 'Authorization' => 'Bearer <token>' ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Get, "https://your-site.webinone.com/api/v2/admin/forms/recurring-types"); request.Headers.Add("Authorization", "Bearer <token>"); var response = await client.SendAsync(request);
Response · 200
[
{
"AccessType": "None",
"IsEnable": false,
"DisplayName": "Example"
}
]Retrieves a single forms types
Response
DisplayNamestring · nullable
Human-readable display name shown to users.
Valuestring · nullable
The stored value of a payment form type option, paired with its display name.
Typeenum
System (pre-defined fields like "Email") or Custom (manually added fields). Possible values: Generic, SingleItem, CheckOut, Recurring, Quote.Possible values: GenericSingleItemCheckOutRecurringQuote
curl "https://your-site.webinone.com/api/v2/admin/forms/types" \ -H "Authorization: Bearer <token>"
await fetch("https://your-site.webinone.com/api/v2/admin/forms/types", { method: "GET", headers: { "Authorization": "Bearer <token>" } });
import requests requests.get( "https://your-site.webinone.com/api/v2/admin/forms/types", headers={"Authorization": "Bearer <token>"} )
$client = new GuzzleHttp\Client(); $response = $client->request('GET', 'https://your-site.webinone.com/api/v2/admin/forms/types', [ 'headers' => [ 'Authorization' => 'Bearer <token>' ] ]);
using var client = new HttpClient(); var request = new HttpRequestMessage(HttpMethod.Get, "https://your-site.webinone.com/api/v2/admin/forms/types"); request.Headers.Add("Authorization", "Bearer <token>"); var response = await client.SendAsync(request);
Response · 200
[
{
"DisplayName": "Example",
"Value": "string",
"Type": "Generic"
}
]