Contributors:
Forms API
Retrieve Forms via the public API endpoint using "where" filtering.
GET Forms List
Retrieves a list of Forms as a JSON response based on your provided query parameters.
/api/v2/admin/forms
Data / Response:
{
"Where" : {},
"Order_By" : "Id",
"Offset" : 0,
"Limit" : 100,
}
{
"Items": [
{
"Id": 0,
"Name": "string",
"Alias": "string",
"Type": "Generic",
"IsSendConfirmEmailNotification": true,
"IsSendSecureZoneLoginDetailsEmail": true,
"IsSecureSubmission": true,
"SubmissionFolderPath": "string",
"FtpPath": "string",
"CreatedDateTime": "2024-05-22T15:30:06.921Z",
"EnabledAutoresponder": true,
"Template": "string",
"RecurringType": "None",
"EnableDefaultJSValidation": true,
"SecureZoneIds": [
0
],
"CustomWorkflowIds": [
0
],
"FormFields": [
{
"Name": "string",
"Alias": "string",
"FieldGroupType": "System",
"IsEditable": true,
"IsComposite": true,
"IsMandatory": true,
"Type": "DateTime"
}
],
"FormAutoresponder": {
"FromName": "string",
"FromEmail": "string",
"Subject": "string",
"Body": "string",
"TemplateId": 0,
"EnableEditor": true
}
}
],
"TotalItemsCount": 0
}
GET Form Item
Retrieves a single Form based on the ID passed in the endpoint URL.
/api/v2/admin/forms/{id}
Data / Response:
N/A
{
"Id": 0,
"Name": "string",
"Alias": "string",
"Type": "Generic",
"IsSendConfirmEmailNotification": true,
"IsSendSecureZoneLoginDetailsEmail": true,
"IsSecureSubmission": true,
"SubmissionFolderPath": "string",
"FtpPath": "string",
"CreatedDateTime": "2024-05-22T15:30:06.924Z",
"EnabledAutoresponder": true,
"Template": "string",
"RecurringType": "None",
"EnableDefaultJSValidation": true,
"SecureZoneIds": [
0
],
"CustomWorkflowIds": [
0
],
"FormFields": [
{
"Name": "string",
"Alias": "string",
"FieldGroupType": "System",
"IsEditable": true,
"IsComposite": true,
"IsMandatory": true,
"Type": "DateTime"
}
],
"FormAutoresponder": {
"FromName": "string",
"FromEmail": "string",
"Subject": "string",
"Body": "string",
"TemplateId": 0,
"EnableEditor": true
}
}