{"openapi":"3.0.0","info":{"title":"Formstack API v2025.0","version":"0.0.4"},"servers":[{"url":"https://www.formstack.com/api/v2025","description":"Production server"},{"url":"https://staging-formstack.com/api/v2025","description":"Staging server"},{"url":"https://dev-formstack.com/api/v2025","description":"Development server"}],"paths":{"/confirmations/{confirmationId}":{"get":{"tags":["Confirmation Emails","Classic"],"description":"Retrieve detailed information for a specific confirmation email","operationId":"getConfirmation","parameters":[{"name":"confirmationId","in":"path","description":"The ID of the confirmation email","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Confirmation email details retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmationDetailedApiDto"}}}},"400":{"description":"A confirmation email ID was not supplied"},"403":{"description":"The action was forbidden by permissions"},"404":{"description":"Invalid confirmation email ID was supplied"},"500":{"description":"Form not found or internal server error"}}},"put":{"tags":["Confirmation Emails","Classic"],"description":"Update an existing confirmation email","operationId":"updateConfirmationEmail","parameters":[{"name":"confirmationId","in":"path","description":"The ID of the confirmation email","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"Update confirmation email request data","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateConfirmationEmailInputApiDto"}}}},"responses":{"200":{"description":"Confirmation email updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmationDetailedApiDto"}}}},"400":{"description":"Invalid request parameters"},"403":{"description":"Forbidden by form permissions"},"404":{"description":"Confirmation email not found"},"500":{"description":"Could not update the confirmation email"}}},"delete":{"tags":["Confirmation Emails","Classic"],"description":"Delete a specific confirmation email","operationId":"deleteConfirmationEmail","parameters":[{"name":"confirmationId","in":"path","description":"The ID of the confirmation email","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Confirmation email deleted successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmationEmailPreviewApiDto"}}}},"400":{"description":"Invalid request parameters"},"403":{"description":"Forbidden by form permissions"},"404":{"description":"Confirmation email not found"},"500":{"description":"Could not delete the confirmation email"}}}},"/forms/{formId}/confirmations":{"get":{"tags":["Confirmation Emails","Classic"],"description":"Retrieve all confirmation emails associated with a form","operationId":"getFormConfirmationEmails","parameters":[{"name":"formId","in":"path","description":"The ID of the form","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Form confirmation emails retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmationEmailsListingApiDto"}}}},"403":{"description":"The action was forbidden by permissions"},"404":{"description":"Form not found"}}},"post":{"tags":["Confirmation Emails","Classic"],"description":"Create a new confirmation email for a form","operationId":"createConfirmationEmail","parameters":[{"name":"formId","in":"path","description":"The ID of the form","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"Create confirmation email request data","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateConfirmationEmailInputApiDto"}}}},"responses":{"201":{"description":"Confirmation email created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConfirmationDetailedApiDto"}}}},"400":{"description":"Invalid request parameters"},"403":{"description":"Forbidden by form permissions"},"404":{"description":"Form not found"},"500":{"description":"Could not create the confirmation email"}}}},"/notifications/{notificationId}":{"get":{"tags":["Notification Emails","Classic"],"description":"Get details for the specified notification email","operationId":"getNotification","parameters":[{"name":"notificationId","in":"path","description":"The ID of the notification email","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Notification email details retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationDetailedApiDto"}}}},"400":{"description":"A notification email ID was not supplied"},"403":{"description":"The action was forbidden by permissions"},"404":{"description":"Invalid notification email ID was supplied"},"500":{"description":"Form not found or retrieving notification email failed"}}},"put":{"tags":["Notification Emails","Classic"],"description":"Update a notification email","operationId":"updateNotificationEmail","parameters":[{"name":"notificationId","in":"path","description":"The ID of the notification email","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"Update notification email request data","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateNotificationEmailInputApiDto"}}}},"responses":{"200":{"description":"Notification email updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationDetailedApiDto"}}}},"400":{"description":"Invalid request parameters"},"403":{"description":"Forbidden by form permissions"},"404":{"description":"Notification email not found"},"500":{"description":"Could not update the notification email"}}},"delete":{"tags":["Notification Emails","Classic"],"description":"Delete a notification email","operationId":"deleteNotificationEmail","parameters":[{"name":"notificationId","in":"path","description":"The ID of the notification email","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Notification email deleted successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationEmailPreviewApiDto"}}}},"400":{"description":"Invalid request parameters"},"403":{"description":"Forbidden by form permissions"},"404":{"description":"Notification email not found"},"500":{"description":"Could not delete the notification email"}}}},"/forms/{formId}/notifications":{"get":{"tags":["Notification Emails","Classic"],"description":"Get notification emails for a form","operationId":"getFormNotificationEmails","parameters":[{"name":"formId","in":"path","description":"The ID of the form","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Form notification emails retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationEmailsListingApiDto"}}}},"403":{"description":"The action was forbidden by permissions"},"404":{"description":"Form not found"}}},"post":{"tags":["Notification Emails","Classic"],"description":"Create a form notification email","operationId":"createNotificationEmail","parameters":[{"name":"formId","in":"path","description":"The ID of the form","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"Create notification email request data","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateNotificationEmailInputApiDto"}}}},"responses":{"201":{"description":"Notification email created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotificationDetailedApiDto"}}}},"400":{"description":"Invalid request parameters"},"403":{"description":"Forbidden by form permissions"},"404":{"description":"Form not found"},"500":{"description":"Could not create the notification email"}}}},"/forms/{formId}/fields/{fieldId}":{"get":{"tags":["Fields","Classic"],"description":"Retrieve detailed information about a specific field","operationId":"getFieldDetails","parameters":[{"name":"formId","in":"path","description":"The ID of the form","required":true,"schema":{"type":"integer"}},{"name":"fieldId","in":"path","description":"The ID of the field","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Detailed field information","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FieldDetailedApiDto"}}}},"403":{"description":"Forbidden"},"404":{"description":"Field not found"}}},"put":{"tags":["Fields","Classic"],"description":"Update an existing field within the specified form","operationId":"editField","parameters":[{"name":"formId","in":"path","description":"The ID of the form","required":true,"schema":{"type":"integer"}},{"name":"fieldId","in":"path","description":"The ID of the field","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditFieldInputApiDto"}}}},"responses":{"200":{"description":"Field resource details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FieldDetailedApiDto"}}}},"400":{"description":"Invalid request body"},"403":{"description":"Forbidden"},"404":{"description":"Field not found"},"500":{"description":"Unable to update field"}}},"delete":{"tags":["Fields","Classic"],"description":"Permanently delete a field from the specified form","operationId":"deleteField","parameters":[{"name":"formId","in":"path","description":"The ID of the form","required":true,"schema":{"type":"integer"}},{"name":"fieldId","in":"path","description":"The ID of the field","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful field deletion","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FieldPreviewApiDto"}}}},"404":{"description":"Field not found"}}}},"/forms/{formId}/fields":{"get":{"tags":["Fields","Classic"],"description":"Retrieve all fields from a form","operationId":"getFormFields","parameters":[{"name":"formId","in":"path","description":"The ID of the form","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"List of form fields","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FieldsListingApiDto"}}}},"403":{"description":"Forbidden"},"404":{"description":"Form not found"}}},"post":{"tags":["Fields","Classic"],"description":"Create a new field within the specified form","operationId":"createFieldInForm","parameters":[{"name":"formId","in":"path","description":"The ID of the form","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFieldInputApiDto"}}}},"responses":{"200":{"description":"Field resource details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FieldDetailedApiDto"}}}},"400":{"description":"Invalid request body"},"403":{"description":"Forbidden"},"404":{"description":"Form not found"},"500":{"description":"Unable to insert field"}}}},"/folders/{folderId}":{"get":{"tags":["Folders","Classic"],"description":"Get details for the specified folder or subfolder.","operationId":"getFolder","parameters":[{"name":"folderId","in":"path","description":"Folder ID","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FolderDetailedApiDto"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Folders","Classic"],"description":"Update the specified folder.","operationId":"editFolder","parameters":[{"name":"folderId","in":"path","description":"Folder ID","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditFolderInputApiDto"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FolderDetailedApiDto"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Folders","Classic"],"description":"Delete the specified folder.","operationId":"deleteFolder","parameters":[{"name":"folderId","in":"path","description":"Folder ID","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FolderIdApiDto"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}},"/folders":{"get":{"tags":["Folders","Classic"],"description":"Get all folders on your account and their subfolders.","operationId":"listFolders","parameters":[{"name":"page","in":"query","description":"Page to use when paginating through folders. Starts at 1.","required":false,"schema":{"type":"integer"}},{"name":"perPage","in":"query","description":"Number of folders to return per page. Minimum page limit is 10.","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FoldersListingApiDto"}}}},"500":{"description":"Internal Server Error"}}},"post":{"tags":["Folders","Classic"],"description":"Create a new folder","operationId":"createFolder","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFolderInputApiDto"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FolderDetailedApiDto"}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal Server Error"}}}},"/forms/{formId}":{"get":{"tags":["Forms","Classic"],"description":"Retrieve detailed information about a specific form","operationId":"getFormDetails","parameters":[{"name":"formId","in":"path","description":"The ID of the form","required":true,"schema":{"type":"integer"}},{"name":"withFields","in":"query","description":"Include form fields in response","required":false,"schema":{"$ref":"#/components/schemas/GetFormDetailsApiDto/properties/withFields"}}],"responses":{"200":{"description":"Form details retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormDetailedApiDto"}}}},"403":{"description":"Forbidden"},"404":{"description":"Form not found"}}},"put":{"tags":["Forms","Classic"],"description":"Update an existing form's properties","operationId":"editForm","parameters":[{"name":"formId","in":"path","description":"The ID of the form","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditFormInputApiDto"}}}},"responses":{"200":{"description":"Get form resource details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormDetailedApiDto"}}}},"400":{"description":"Invalid request body"},"403":{"description":"Forbidden"},"404":{"description":"Not found"},"500":{"description":"Unable to update form"}}},"delete":{"tags":["Forms","Classic"],"description":"Soft delete a form (mark as deleted)","operationId":"deleteForm","parameters":[{"name":"formId","in":"path","description":"The ID of the form","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Successful form deletion","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormPreviewApiDto"}}}},"404":{"description":"Form not found"},"500":{"description":"Unable to delete form"}}}},"/forms":{"get":{"tags":["Forms","Classic"],"description":"Retrieve a paginated list of forms with optional filtering and sorting","operationId":"getFormsList","parameters":[{"name":"pageNumber","in":"query","description":"Page number to use when paginating through forms","required":false,"schema":{"$ref":"#/components/schemas/GetFormsListApiDto/properties/pageNumber"}},{"name":"pageSize","in":"query","description":"Number of forms to return per page","required":false,"schema":{"$ref":"#/components/schemas/GetFormsListApiDto/properties/pageSize"}},{"name":"search","in":"query","description":"Search by form name","required":false,"schema":{"$ref":"#/components/schemas/GetFormsListApiDto/properties/search"}},{"name":"orderBy","in":"query","description":"Column to order results by","required":false,"schema":{"$ref":"#/components/schemas/GetFormsListApiDto/properties/orderBy"}},{"name":"order","in":"query","description":"Sort direction for results (asc or desc)","required":false,"schema":{"$ref":"#/components/schemas/GetFormsListApiDto/properties/order"}},{"name":"folder","in":"query","description":"Filter forms by folder ID","required":false,"schema":{"$ref":"#/components/schemas/GetFormsListApiDto/properties/folder"}}],"responses":{"200":{"description":"Forms list retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormsListingApiDto"}}}},"404":{"description":"Folder not found"}}},"post":{"tags":["Forms","Classic"],"description":"Create a new form with optional fields","operationId":"createForm","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFormInputApiDto"}}}},"responses":{"200":{"description":"Create form resource details with fields","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormDetailedApiDto"}}}},"400":{"description":"Invalid request body"},"403":{"description":"Forbidden"},"404":{"description":"Form not found"},"500":{"description":"Unable to insert form"}}}},"/forms/{formId}/copy":{"post":{"tags":["Forms","Classic"],"description":"Create a copy of an existing form with optional configurations","operationId":"copyForm","parameters":[{"name":"formId","in":"path","description":"The ID of the form","required":true,"schema":{"type":"integer"}},{"name":"includeIntegrations","in":"query","description":"Flag to specify whether to copy integrations","required":false,"schema":{"$ref":"#/components/schemas/CopyFormOptionsApiDto/properties/includeIntegrations"}},{"name":"includeEmails","in":"query","description":"Flag to specify whether to copy emails","required":false,"schema":{"$ref":"#/components/schemas/CopyFormOptionsApiDto/properties/includeEmails"}},{"name":"template","in":"query","description":"Id of template to use when copying","required":false,"schema":{"$ref":"#/components/schemas/CopyFormOptionsApiDto/properties/template"}},{"name":"folder","in":"query","description":"Id of folder where copy should be saved","required":false,"schema":{"$ref":"#/components/schemas/CopyFormOptionsApiDto/properties/folder"}}],"responses":{"200":{"description":"Get form resource details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormDetailedApiDto"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not found"}}}},"/forms/{formId}/prefill":{"post":{"tags":["Forms","Classic"],"description":"Generate a prefilled form URL with specified field values","operationId":"createFormPrefill","parameters":[{"name":"formId","in":"path","description":"The ID of the form","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFormPrefillApiDto"}}}},"responses":{"200":{"description":"Get form prefill URL","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PrefillResponseApiDto"}}}},"400":{"description":"Invalid request body"},"403":{"description":"Forbidden"},"404":{"description":"Form not found"},"500":{"description":"Unable to save prefill for form"}}}},"/forms/{formId}/html":{"get":{"tags":["Forms","Classic"],"description":"Retrieve HTML markup for a specific form","operationId":"getFormHtml","parameters":[{"name":"formId","in":"path","description":"The ID of the form","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Form HTML retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormHtmlApiDto"}}}},"404":{"description":"Form not found"}}}},"/forms/{formId}/integrations/webmerge":{"post":{"tags":["Submit Actions"],"description":"Create a form WebMerge integration","operationId":"createFormWebmergeIntegration","parameters":[{"name":"formId","in":"path","description":"The ID of the form","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"Create Form Integration DTO","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateFormIntegrationInputApiDto"}}}},"responses":{"201":{"description":"Form integration created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormstackDocumentIntegrationDetailedApiDto"}}}},"400":{"description":"Invalid request parameters"},"403":{"description":"Forbidden by form permissions"},"404":{"description":"Form not found"},"500":{"description":"Could not create the form integration"}}}},"/partialsubmission/{partialSubmissionId}":{"get":{"tags":["PartialSubmissions","Classic"],"description":"Get detailed information about a partial submission","operationId":"getPartialSubmissionDetails","parameters":[{"name":"partialSubmissionId","in":"path","description":"The ID of the partial submission to retrieve","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartialSubmissionDetailedApiDto"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["PartialSubmissions","Classic"],"description":"Delete a partial submission","operationId":"deletePartialSubmission","parameters":[{"name":"partialSubmissionId","in":"path","description":"The ID of the partial submission to delete","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartialSubmissionIdApiDto"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}},"/form/{formId}/partialsubmission":{"get":{"tags":["PartialSubmissions","Classic"],"description":"Get a list of partial submissions for a form","operationId":"getPartialSubmissionsList","parameters":[{"name":"formId","in":"path","description":"The ID of the form","required":true,"schema":{"type":"integer"}},{"name":"pageNumber","in":"query","description":"Page to use when paginating through partial submissions.","required":false,"schema":{"$ref":"#/components/schemas/GetPartialSubmissionsListApiDto/properties/pageNumber"}},{"name":"pageSize","in":"query","description":"Number of partial submissions to return per page.","required":false,"schema":{"$ref":"#/components/schemas/GetPartialSubmissionsListApiDto/properties/pageSize"}},{"name":"order","in":"query","description":"Order direction of results.","required":false,"schema":{"$ref":"#/components/schemas/GetPartialSubmissionsListApiDto/properties/order"}},{"name":"keyword","in":"query","description":"Keyword to search.","required":false,"schema":{"$ref":"#/components/schemas/GetPartialSubmissionsListApiDto/properties/keyword"}},{"name":"minTime","in":"query","description":"Return partial submissions created at and after the given date/time. Format: YYYY-MM-DD or YYYY-MM-DD HH:MM:SS (Eastern Time).","required":false,"schema":{"$ref":"#/components/schemas/GetPartialSubmissionsListApiDto/properties/minTime"}},{"name":"maxTime","in":"query","description":"Return partial submissions created at and before the given date/time. Format: YYYY-MM-DD or YYYY-MM-DD HH:MM:SS (Eastern Time).","required":false,"schema":{"$ref":"#/components/schemas/GetPartialSubmissionsListApiDto/properties/maxTime"}},{"name":"search","in":"query","description":"Field ids and related values to search (according to the following pattern where search index has to be smaller than 10: search[0][fieldId]=111&search[0][value]=foo&search[1][fieldId]=112&search[1][value]=bar).","required":false,"schema":{"$ref":"#/components/schemas/GetPartialSubmissionsListApiDto/properties/search"}},{"name":"data","in":"query","description":"Set to 'true' to include partial submission data in the response.","required":false,"schema":{"$ref":"#/components/schemas/GetPartialSubmissionsListApiDto/properties/data"}},{"name":"expandData","in":"query","description":"Set to 'true' to expand partial submission data with detailed field information.","required":false,"schema":{"$ref":"#/components/schemas/GetPartialSubmissionsListApiDto/properties/expandData"}},{"name":"prettyName","in":"query","description":"Set to 'true' to include pretty names for partial submissions.","required":false,"schema":{"$ref":"#/components/schemas/GetPartialSubmissionsListApiDto/properties/prettyName"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PartialSubmissionsListingApiDto"}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal server error"}}}},"/portal/{portalId}/avatar":{"post":{"tags":["Portals","Classic"],"description":"Create the portal avatar","operationId":"createPortalAvatar","parameters":[{"name":"portalId","in":"path","description":"Portal ID","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalDetailedApiDto"}}}},"400":{"description":"Bad Request"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Portals","Classic"],"description":"Delete the portal avatar.","operationId":"deletePortalAvatar","parameters":[{"name":"portalId","in":"path","description":"Portal ID","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalIdApiDto"}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}},"/portal/{portalId}/copy":{"post":{"tags":["Portals","Classic"],"description":"Create the portal copy","operationId":"createPortalCopy","parameters":[{"name":"portalId","in":"path","description":"Portal ID","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalDetailedApiDto"}}}},"400":{"description":"Bad Request"},"500":{"description":"Internal Server Error"}}}},"/portal/{portalId}/form":{"post":{"tags":["Portals","Classic"],"description":"Create the portal form.","operationId":"createPortalForm","parameters":[{"name":"portalId","in":"path","description":"Portal ID","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePortalFormInputApiDto"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalFormApiDto"}}}},"400":{"description":"Bad Request"},"500":{"description":"Internal Server Error"}}}},"/portal/{portalId}/user":{"post":{"tags":["Portals","Classic"],"description":"Create the portal user","operationId":"createPortalUser","parameters":[{"name":"portalId","in":"path","description":"Portal ID","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePortalUserInputApiDto"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalDetailedApiDto"}}}},"400":{"description":"Bad Request"},"500":{"description":"Internal Server Error"}}}},"/portal/{portalId}":{"get":{"tags":["Portals","Classic"],"description":"Retrieve detailed information for a specific portal, including associated forms and users.","operationId":"getPortal","parameters":[{"name":"portalId","in":"path","description":"Unique identifier of the portal to retrieve","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalDetailedApiDto"}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Portals","Classic"],"description":"Edit the portal","operationId":"editPortal","parameters":[{"name":"portalId","in":"path","description":"Portal ID","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditPortalInputApiDto"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalDetailedApiDto"}}}},"400":{"description":"Bad Request"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Portals","Classic"],"description":"Permanently delete a specific portal.","operationId":"deletePortal","parameters":[{"name":"portalId","in":"path","description":"Unique identifier of the portal to delete","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalIdApiDto"}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}},"/portal/{portalId}/form/{formId}":{"put":{"tags":["Portals","Classic"],"description":"Edit the portal form","operationId":"editPortalForm","parameters":[{"name":"portalId","in":"path","description":"Portal ID","required":true,"schema":{"type":"integer"}},{"name":"formId","in":"path","description":"Form ID","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditPortalFormInputApiDto"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalFormApiDto"}}}},"400":{"description":"Bad Request"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Portals","Classic"],"description":"Delete a form from the portal.","operationId":"deletePortalForm","parameters":[{"name":"portalId","in":"path","description":"Portal ID","required":true,"schema":{"type":"integer"}},{"name":"formId","in":"path","description":"Form ID","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalAndFormIdApiDto"}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}},"/portal/{portalId}/user/{userId}":{"put":{"tags":["Portals","Classic"],"description":"Edit the portal user","operationId":"editPortalUser","parameters":[{"name":"portalId","in":"path","description":"Portal ID","required":true,"schema":{"type":"integer"}},{"name":"userId","in":"path","description":"User ID","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditPortalUserInputApiDto"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalUserApiDto"}}}},"400":{"description":"Bad Request"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Portals","Classic"],"description":"Remove a user from the portal.","operationId":"deletePortalUser","parameters":[{"name":"portalId","in":"path","description":"Portal ID","required":true,"schema":{"type":"integer"}},{"name":"userId","in":"path","description":"User ID","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalAndUserIdApiDto"}}}},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}},"/portal":{"get":{"tags":["Portals","Classic"],"description":"Retrieve a list of all portals associated with your account.","operationId":"listPortals","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PortalsListingApiDto"}}}},"500":{"description":"Internal Server Error"}}}},"/smartlists/{smartListId}/bulkoptions":{"post":{"tags":["Smart List Options"],"operationId":"createBulkSmartListOptions","parameters":[{"name":"smartListId","in":"path","description":"ID of the smart list to add options to","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"Bulk smart list options data","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkSmartListOptionsInputApiDto"}}}},"responses":{"200":{"description":"Bulk options created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceIdDto"}}}},"400":{"description":"Bad Request - Invalid input data"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Smart List not found"}}}},"/smartlists":{"get":{"tags":["Smart List"],"operationId":"listSmartLists","parameters":[{"name":"pageNumber","in":"query","description":"Page number","required":false,"schema":{"$ref":"#/components/schemas/GetSmartListsListApiDto/properties/pageNumber"}},{"name":"pageSize","in":"query","description":"Number of items per page","required":false,"schema":{"$ref":"#/components/schemas/GetSmartListsListApiDto/properties/pageSize"}},{"name":"query","in":"query","description":"Search query","required":false,"schema":{"$ref":"#/components/schemas/GetSmartListsListApiDto/properties/query"}}],"responses":{"200":{"description":"List of smart lists","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartListsListingApiDto"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}},"post":{"tags":["Smart List"],"operationId":"createSmartList","requestBody":{"description":"Smart list data","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSmartListInputApiDto"}}}},"responses":{"201":{"description":"Smart List created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartListDetailedApiDto"}}}},"400":{"description":"Bad Request - Invalid input data"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"}}}},"/smartlists/{smartListId}":{"get":{"tags":["Smart List"],"operationId":"getSmartList","parameters":[{"name":"smartListId","in":"path","description":"ID of the smart list to retrieve","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"SmartList details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartListDetailedApiDto"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"SmartList not found"}}},"put":{"tags":["Smart List"],"operationId":"updateSmartList","parameters":[{"name":"smartListId","in":"path","description":"ID of the smart list to update","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"Smart list data to update","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSmartListInputApiDto"}}}},"responses":{"200":{"description":"SmartList updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartListDetailedApiDto"}}}},"400":{"description":"Bad Request - Invalid input data"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"SmartList not found"}}},"delete":{"tags":["Smart List"],"operationId":"deleteSmartList","parameters":[{"name":"smartListId","in":"path","description":"ID of the smart list to delete","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"SmartList deleted successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceIdDto"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"SmartList not found"}}}},"/smartlists/{smartListId}/options":{"get":{"tags":["Smart List Options"],"operationId":"listSmartListOptions","parameters":[{"name":"smartListId","in":"path","description":"ID of the smart list","required":true,"schema":{"type":"integer"}},{"name":"pageNumber","in":"query","description":"Page number","required":false,"schema":{"$ref":"#/components/schemas/GetSmartListOptionsListApiDto/properties/pageNumber"}},{"name":"pageSize","in":"query","description":"Number of items per page","required":false,"schema":{"$ref":"#/components/schemas/GetSmartListOptionsListApiDto/properties/pageSize"}},{"name":"query","in":"query","description":"Search query to filter options by label","required":false,"schema":{"$ref":"#/components/schemas/GetSmartListOptionsListApiDto/properties/query"}}],"responses":{"200":{"description":"List of smart list options","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartListOptionsListingApiDto"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"SmartList not found"}}},"post":{"tags":["Smart List Options"],"operationId":"createSmartListOption","parameters":[{"name":"smartListId","in":"path","description":"ID of the smart list to add option to","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"Smart list option data","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSmartListOptionInputApiDto"}}}},"responses":{"201":{"description":"Smart List option created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartListOptionDetailedApiDto"}}}},"400":{"description":"Bad Request - Invalid input data"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Smart List not found"}}}},"/smartlists/{smartListId}/alloptions":{"delete":{"tags":["Smart List Options"],"operationId":"deleteAllSmartListOptions","parameters":[{"name":"smartListId","in":"path","description":"ID of the smart list","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"All options deleted successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceIdDto"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"SmartList not found"}}}},"/smartlists/{smartListId}/options/{optionId}":{"get":{"tags":["Smart List Options"],"operationId":"getSmartListOption","parameters":[{"name":"smartListId","in":"path","description":"ID of the smart list","required":true,"schema":{"type":"integer"}},{"name":"optionId","in":"path","description":"ID of the option to retrieve","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"SmartList option details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartListOptionDetailedApiDto"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"SmartList or option not found"}}},"put":{"tags":["Smart List Options"],"operationId":"updateSmartListOption","parameters":[{"name":"smartListId","in":"path","description":"ID of the smart list containing the option","required":true,"schema":{"type":"integer"}},{"name":"optionId","in":"path","description":"ID of the option to update","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"Smart list option data to update","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateSmartListOptionInputApiDto"}}}},"responses":{"200":{"description":"SmartList option updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartListOptionDetailedApiDto"}}}},"400":{"description":"Bad Request - Invalid input data"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"SmartList or option not found"}}},"delete":{"tags":["Smart List Options"],"operationId":"deleteSmartListOption","parameters":[{"name":"smartListId","in":"path","description":"ID of the smart list","required":true,"schema":{"type":"integer"}},{"name":"optionId","in":"path","description":"ID of the option to delete","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Option deleted successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceIdDto"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"SmartList or option not found"}}}},"/smartlists/{smartListId}/options/{optionId}/image":{"post":{"tags":["Smart List Options"],"operationId":"uploadSmartListOptionImage","parameters":[{"name":"smartListId","in":"path","description":"ID of the smart list containing the option","required":true,"schema":{"type":"integer"}},{"name":"optionId","in":"path","description":"ID of the option to upload image for","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"Image file to upload or null to delete","required":false,"content":{"multipart/form-data":{"schema":{"properties":{"image":{"description":"Image file (null to delete existing image)","type":"string","format":"binary"}},"type":"object"}}}},"responses":{"200":{"description":"Image uploaded successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmartListOptionDetailedApiDto"}}}},"400":{"description":"Bad Request - Invalid file or Smart List does not use images"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"SmartList or option not found"}}},"delete":{"tags":["Smart List Options"],"operationId":"deleteSmartListOptionImage","parameters":[{"name":"smartListId","in":"path","description":"ID of the smart list","required":true,"schema":{"type":"integer"}},{"name":"optionId","in":"path","description":"ID of the option whose image should be deleted","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Option image deleted successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceIdDto"}}}},"400":{"description":"Invalid request or SmartList does not use images"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"SmartList or option not found"}}}},"/subaccount/{subaccountId}/form/{formId}/copy":{"post":{"tags":["Subaccounts"],"description":"Copies a form from the current account to a specified subaccount","operationId":"subaccountCopyForm","parameters":[{"name":"subaccountId","in":"path","description":"Unique identifier of the target subaccount","required":true,"schema":{"type":"integer"}},{"name":"formId","in":"path","description":"Unique identifier of the form to be copied","required":true,"schema":{"type":"integer"}},{"name":"withIntegrations","in":"query","description":"Whether to include integrations when copying the form","required":false,"schema":{"type":"boolean","default":false}}],"responses":{"201":{"description":"Form copied successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormDetailedApiDto"}}}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"404":{"description":"Not found"}}}},"/subaccount/{subaccountId}/forms/{formId}/theme":{"put":{"tags":["Subaccounts"],"description":"Assign a theme to a specific form in the subaccount","operationId":"assignThemeToSubaccountForm","parameters":[{"name":"subaccountId","in":"path","description":"Unique identifier of the subaccount","required":true,"schema":{"type":"integer"}},{"name":"formId","in":"path","description":"Unique identifier of the form","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"Theme assignment data","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubaccountAssignThemeToFormApiDto"}}}},"responses":{"200":{"description":"Theme assigned successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubaccountFormThemeAssignDto"}}}},"400":{"description":"Bad request - Invalid theme or form"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden - No permission to modify form or use theme"},"404":{"description":"Subaccount, form or theme not found"}}}},"/subaccount":{"get":{"tags":["Subaccounts"],"description":"Retrieves a list of all subaccounts associated with the current account","operationId":"listSubaccounts","responses":{"200":{"description":"Successfully retrieved subaccounts list","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubaccountsListingApiDto"}}}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"}}}},"/subaccount/{subaccountId}/theme/{themeId}/copy":{"post":{"tags":["Subaccounts"],"description":"Copies a theme from the current account to a specified subaccount","operationId":"copyThemeToSubaccount","parameters":[{"name":"subaccountId","in":"path","description":"Unique identifier of the target subaccount","required":true,"schema":{"type":"integer"}},{"name":"themeId","in":"path","description":"Unique identifier of the theme to be copied","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Theme copied successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubaccountThemeIdApiDto"}}}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"404":{"description":"Not found"}}}},"/subaccount/{subaccountId}/themes/{themeId}":{"delete":{"tags":["Subaccounts"],"description":"Delete a theme from the specified subaccount. Forms using this theme will be switched to the default theme.","operationId":"deleteSubaccountTheme","parameters":[{"name":"subaccountId","in":"path","description":"Unique identifier of the subaccount","required":true,"schema":{"type":"integer"}},{"name":"themeId","in":"path","description":"Unique identifier of the theme to delete","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Theme deleted successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThemeDeleteDto"}}}},"400":{"description":"Bad request - Theme cannot be deleted"},"401":{"description":"Unauthorized"},"404":{"description":"Subaccount or theme not found"},"409":{"description":"Conflict - Theme is in use and cannot be deleted"}}}},"/subaccount/{subaccountId}/themes/{themeId}/forms":{"get":{"tags":["Subaccounts"],"description":"Get a paginated list of forms using the specified theme in the subaccount","operationId":"getSubaccountThemeFormList","parameters":[{"name":"subaccountId","in":"path","description":"Unique identifier of the subaccount","required":true,"schema":{"type":"integer"}},{"name":"themeId","in":"path","description":"Unique identifier of the theme","required":true,"schema":{"type":"string"}},{"name":"pageNumber","in":"query","description":"Page number (1-based)","required":false,"schema":{"$ref":"#/components/schemas/GetThemeFormListApiDto/properties/pageNumber"}},{"name":"pageSize","in":"query","description":"Number of items per page","required":false,"schema":{"$ref":"#/components/schemas/GetThemeFormListApiDto/properties/pageSize"}}],"responses":{"200":{"description":"Forms retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubaccountThemeFormListDto"}}}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"404":{"description":"Subaccount or theme not found"}}}},"/subaccount/{subaccountId}/themes":{"get":{"tags":["Subaccounts"],"description":"Get a paginated list of themes available in the specified subaccount","operationId":"getSubaccountThemes","parameters":[{"name":"subaccountId","in":"path","description":"Unique identifier of the subaccount","required":true,"schema":{"type":"integer"}},{"name":"pageNumber","in":"query","description":"Page number (1-based)","required":false,"schema":{"$ref":"#/components/schemas/GetThemeListApiDto/properties/pageNumber"}},{"name":"pageSize","in":"query","description":"Number of items per page","required":false,"schema":{"$ref":"#/components/schemas/GetThemeListApiDto/properties/pageSize"}}],"responses":{"200":{"description":"Themes retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThemeListDto"}}}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"404":{"description":"Subaccount not found"}}}},"/forms/{formId}/fields/{fieldId}/upload-urls":{"post":{"tags":["Submissions","Classic"],"description":"Generate presigned S3 upload URLs for a file field. Upload each file directly to its returned `uploadUrl` with an HTTP PUT (bypassing the request-body size limit), then submit the matching `fileKey` as the field's `subvalue` when creating the submission. Presigned URLs expire after 2 hours.","operationId":"createFileUploadUrls","parameters":[{"name":"formId","in":"path","description":"The unique identifier of the form","required":true,"schema":{"type":"integer"}},{"name":"fieldId","in":"path","description":"The file field to upload to","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUploadUrlsInputApiDto"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileUploadUrlsApiDto"}}}},"400":{"description":"Invalid request: filenames missing/empty, more than the per-field file limit, or the field is not a file field"},"403":{"description":"Forbidden"},"404":{"description":"Form or field not found"}}}},"/forms/{formId}/submissions/count":{"get":{"tags":["Submissions","Classic"],"description":"Counting form submissions","operationId":"countFormSubmissions","parameters":[{"name":"formId","in":"path","description":"The ID of the form","required":true,"schema":{"type":"integer"}},{"name":"startDate","in":"query","description":"When to start submission count from.","required":false,"schema":{"$ref":"#/components/schemas/CountFormSubmissionsApiDto/properties/startDate"}},{"name":"lookbackPeriod","in":"query","description":"How many days to count backwards from (maximum is 7 days).","required":false,"schema":{"$ref":"#/components/schemas/CountFormSubmissionsApiDto/properties/lookbackPeriod"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormSubmissionCountApiDto"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}},"/forms/{formId}/submissions":{"get":{"tags":["Submissions","Classic"],"description":"Retrieve a paginated list of submissions for a specific form","operationId":"getFormSubmissionsList","parameters":[{"name":"formId","in":"path","description":"The unique identifier of the form to retrieve submissions from","required":true,"schema":{"type":"integer"}},{"name":"pageNumber","in":"query","description":"Page number for pagination (starting from 1)","required":false,"schema":{"$ref":"#/components/schemas/GetFormSubmissionsListApiDto/properties/pageNumber"}},{"name":"pageSize","in":"query","description":"Maximum number of submissions to return per page (default: 25, max: 100)","required":false,"schema":{"$ref":"#/components/schemas/GetFormSubmissionsListApiDto/properties/pageSize"}},{"name":"order","in":"query","description":"Sort order for results (ASC for ascending, DESC for descending)","required":false,"schema":{"$ref":"#/components/schemas/GetFormSubmissionsListApiDto/properties/order"}},{"name":"keyword","in":"query","description":"Search term to filter submissions by content across all fields","required":false,"schema":{"$ref":"#/components/schemas/GetFormSubmissionsListApiDto/properties/keyword"}},{"name":"minTime","in":"query","description":"Return submissions created on or after this date/time (format: YYYY-MM-DD or YYYY-MM-DD HH:MM:SS in Eastern Time)","required":false,"schema":{"$ref":"#/components/schemas/GetFormSubmissionsListApiDto/properties/minTime"}},{"name":"maxTime","in":"query","description":"Return submissions created on or before this date/time (format: YYYY-MM-DD or YYYY-MM-DD HH:MM:SS in Eastern Time)","required":false,"schema":{"$ref":"#/components/schemas/GetFormSubmissionsListApiDto/properties/maxTime"}},{"name":"search","in":"query","description":"Search specific fields by ID and value. Use array format in query string: search[0][fieldId]=111&search[0][value]=foo&search[1][fieldId]=112&search[1][value]=bar (supports up to 10 search criteria)","required":false,"schema":{"$ref":"#/components/schemas/GetFormSubmissionsListApiDto/properties/search"},"example":"search[0][fieldId]=123456&search[0][value]=john@example.com"},{"name":"data","in":"query","description":"Include field data in the response (true/false)","required":false,"schema":{"$ref":"#/components/schemas/GetFormSubmissionsListApiDto/properties/data"}},{"name":"expandData","in":"query","description":"Include expanded field data with parsed values (true/false)","required":false,"schema":{"$ref":"#/components/schemas/GetFormSubmissionsListApiDto/properties/expandData"}},{"name":"prettyName","in":"query","description":"Include a human-readable name for each submission based on name or email fields (true/false)","required":false,"schema":{"$ref":"#/components/schemas/GetFormSubmissionsListApiDto/properties/prettyName"}},{"name":"dataFormat","in":"query","description":"Shape of the 'data' field: 'legacy' (default, object keyed by field id) or 'standardized' (array of field objects matching GET /submissions/{id})","required":false,"schema":{"$ref":"#/components/schemas/GetFormSubmissionsListApiDto/properties/dataFormat"}},{"name":"X-FS-Encryption-Password","in":"header","description":"Required when form has encryption enabled and data=true or prettyName=true. The encryption password used to decrypt submission data","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormSubmissionsListingApiDto"}}}},"401":{"description":"Unauthorized - Encryption password required or invalid"},"403":{"description":"Forbidden"},"500":{"description":"Internal server error"}}},"post":{"tags":["Submissions","Classic"],"description":"Create a new submission for the specified form","operationId":"createSubmission","parameters":[{"name":"formId","in":"path","description":"The unique identifier of the form to submit to","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSubmissionInputApiDto"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmissionCreateApiDto"}}}},"400":{"description":"Invalid request: for a file or signature field this includes mixing presigned fileKeys with inline base64 uploads in the same field, an unknown fileKey, or a file that violates the field size limits"}}}},"/submissions/{submissionId}":{"get":{"tags":["Submissions","Classic"],"description":"Retrieve detailed information about a specific submission","operationId":"getSubmissionDetails","parameters":[{"name":"submissionId","in":"path","description":"The unique identifier of the submission to retrieve","required":true,"schema":{"type":"integer"}},{"name":"X-FS-Encryption-Password","in":"header","description":"Required when form has encryption enabled. The encryption password used to decrypt submission data","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmissionDetailedApiDto"}}}},"401":{"description":"Unauthorized - Encryption password required or invalid"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}},"put":{"tags":["Submissions","Classic"],"description":"Update an existing submission with new data","operationId":"editSubmission","parameters":[{"name":"submissionId","in":"path","description":"The unique identifier of the submission to edit","required":true,"schema":{"type":"integer"}},{"name":"X-FS-Encryption-Password","in":"header","description":"Required when form has encryption enabled. The encryption password used to decrypt and re-encrypt submission data","required":false,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditSubmissionInputApiDto"}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmissionEditApiDto"}}}},"400":{"description":"Invalid request: for a file or signature field this includes mixing presigned fileKeys with inline base64 uploads in the same field, an unknown fileKey, or a file that violates the field size limits"},"401":{"description":"Unauthorized - Encryption password required or invalid"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}},"delete":{"tags":["Submissions","Classic"],"description":"Permanently delete a submission and all associated data","operationId":"deleteSubmission","parameters":[{"name":"submissionId","in":"path","description":"The unique identifier of the submission to delete","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmissionDeleteApiDto"}}}},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}},"/submissions/{submissionId}/upload":{"get":{"tags":["Submissions","Classic"],"description":"Retrieve uploaded file from a submission","operationId":"getSubmissionUpload","parameters":[{"name":"submissionId","in":"path","description":"The unique identifier of the submission containing the upload","required":true,"schema":{"type":"integer"}},{"name":"fieldId","in":"query","description":"The unique identifier of the field containing the uploaded file","required":true,"schema":{"$ref":"#/components/schemas/GetSubmissionUploadApiDto/properties/fieldId"}},{"name":"index","in":"query","description":"The index of the file when multiple files are uploaded to the same field (zero-based)","required":false,"schema":{"$ref":"#/components/schemas/GetSubmissionUploadApiDto/properties/index"}},{"name":"X-FS-Encryption-Password","in":"header","description":"Required when form has encryption enabled. The encryption password used to decrypt file upload data","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"401":{"description":"Unauthorized - Encryption password required or invalid"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"},"500":{"description":"Internal Server Error"}}}},"/submissions":{"get":{"tags":["Submissions","Classic"],"description":"Retrieve a paginated list of submissions across all forms","operationId":"getSubmissionsList","parameters":[{"name":"search","in":"query","description":"Search term to filter submissions by content","required":true,"schema":{"$ref":"#/components/schemas/GetSubmissionsListApiDto/properties/search"}},{"name":"pageNumber","in":"query","description":"Page number for pagination (starting from 1)","required":false,"schema":{"$ref":"#/components/schemas/GetSubmissionsListApiDto/properties/pageNumber"}},{"name":"pageSize","in":"query","description":"Maximum number of submissions to return per page (default: 25, max: 100)","required":false,"schema":{"$ref":"#/components/schemas/GetSubmissionsListApiDto/properties/pageSize"}},{"name":"order","in":"query","description":"Sort order for results (ASC for ascending, DESC for descending)","required":false,"schema":{"$ref":"#/components/schemas/GetSubmissionsListApiDto/properties/order"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmissionsListingApiDto"}}}},"403":{"description":"Forbidden"},"500":{"description":"Internal server error"}}}},"/forms/{formId}/submitactions":{"get":{"tags":["Submit Actions"],"description":"Retrieve all submit actions configured for a specific form","operationId":"listSubmitActions","parameters":[{"name":"formId","in":"path","description":"Unique identifier of the form to list submit actions for","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Submit actions retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitActionsListingApiDto"}}}},"403":{"description":"Access denied - insufficient permissions"},"404":{"description":"Form not found"}}},"post":{"tags":["Submit Actions"],"description":"Create a new submit action that defines what happens after a form is submitted","operationId":"createSubmitAction","parameters":[{"name":"formId","in":"path","description":"Unique identifier of the form to add the submit action to","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSubmitActionInputApiDto"}}}},"responses":{"201":{"description":"Submit action created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitActionDetailedApiDto"}}}},"400":{"description":"Invalid request data or validation failed"},"403":{"description":"Access denied - insufficient permissions"},"404":{"description":"Form not found"},"500":{"description":"Internal server error during submit action creation"}}}},"/forms/{formId}/submitactions/{submitActionId}":{"get":{"tags":["Submit Actions"],"description":"Retrieve detailed information about a specific submit action","operationId":"getSubmitAction","parameters":[{"name":"formId","in":"path","description":"Unique identifier of the form that contains the submit action","required":true,"schema":{"type":"integer"}},{"name":"submitActionId","in":"path","description":"Unique identifier of the submit action to retrieve","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Submit action details retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitActionDetailedApiDto"}}}},"403":{"description":"Access denied - insufficient permissions"},"404":{"description":"Submit action or form not found"}}},"put":{"tags":["Submit Actions"],"description":"Update the configuration of an existing submit action","operationId":"updateSubmitAction","parameters":[{"name":"formId","in":"path","description":"Unique identifier of the form that contains the submit action","required":true,"schema":{"type":"integer"}},{"name":"submitActionId","in":"path","description":"Unique identifier of the submit action to update","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditSubmitActionInputApiDto"}}}},"responses":{"200":{"description":"Submit action updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubmitActionDetailedApiDto"}}}},"400":{"description":"Invalid request data or validation failed"},"403":{"description":"Access denied - insufficient permissions"},"404":{"description":"Submit action or form not found"},"500":{"description":"Internal server error during submit action update"}}},"delete":{"tags":["Submit Actions"],"description":"Permanently remove a submit action from a form","operationId":"deleteSubmitAction","parameters":[{"name":"formId","in":"path","description":"Unique identifier of the form that contains the submit action","required":true,"schema":{"type":"integer"}},{"name":"submitActionId","in":"path","description":"Unique identifier of the submit action to delete","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Submit action deleted successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceIdDto"}}}},"403":{"description":"Access denied - insufficient permissions"},"404":{"description":"Submit action or form not found"},"500":{"description":"Internal server error during submit action deletion"}}}},"/forms/{formId}/theme":{"put":{"tags":["Themes"],"description":"Assign a theme to a specific form in the current account","operationId":"assignThemeToForm","parameters":[{"name":"formId","in":"path","description":"Unique identifier of the form","required":true,"schema":{"type":"integer"}}],"requestBody":{"description":"Theme assignment data","required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssignThemeToFormApiDto"}}}},"responses":{"200":{"description":"Theme assigned successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormThemeAssignDto"}}}},"400":{"description":"Bad request - Invalid theme or form"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden - No permission to modify form or use theme"},"404":{"description":"Form or theme not found"}}}},"/themes/{themeId}/copy":{"post":{"tags":["Themes"],"description":"Copies a theme within the current account (creates a duplicate)","operationId":"copyTheme","parameters":[{"name":"themeId","in":"path","description":"Unique identifier of the theme to be copied","required":true,"schema":{"type":"string"}}],"responses":{"201":{"description":"Theme copied successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThemeIdApiDto"}}}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"},"404":{"description":"Theme not found"}}}},"/themes/{themeId}":{"delete":{"tags":["Themes"],"description":"Delete a custom theme from the current account. Forms using this theme will be switched to the default theme.","operationId":"deleteTheme","parameters":[{"name":"themeId","in":"path","description":"Unique identifier of the theme to delete","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Theme deleted successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThemeDeleteDto"}}}},"400":{"description":"Bad request - Theme cannot be deleted"},"401":{"description":"Unauthorized"},"404":{"description":"Theme not found"},"409":{"description":"Conflict - Theme is in use and cannot be deleted"}}}},"/themes":{"get":{"tags":["Themes"],"description":"Get a paginated list of themes available in the current account","operationId":"getAccountThemes","parameters":[{"name":"pageNumber","in":"query","description":"Page number (1-based)","required":false,"schema":{"$ref":"#/components/schemas/GetThemeListApiDto/properties/pageNumber"}},{"name":"pageSize","in":"query","description":"Number of items per page","required":false,"schema":{"$ref":"#/components/schemas/GetThemeListApiDto/properties/pageSize"}}],"responses":{"200":{"description":"Themes retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThemeListDto"}}}},"400":{"description":"Bad request"},"401":{"description":"Unauthorized"}}}},"/forms/{formId}/webhooks":{"get":{"tags":["Webhook"],"description":"List webhooks for a form","operationId":"listWebhooks","parameters":[{"name":"formId","in":"path","description":"The ID of the form","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"List of webhooks","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhooksListingApiDto"}}}},"403":{"description":"Forbidden"},"404":{"description":"Form not found"}}},"post":{"tags":["Webhook"],"description":"Create a new webhook for a form","operationId":"createWebhook","parameters":[{"name":"formId","in":"path","description":"The ID of the form","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWebhookInputApiDto"}}}},"responses":{"201":{"description":"Webhook created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookDetailedApiDto"}}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"},"404":{"description":"Form not found"},"500":{"description":"Failed to create webhook"}}}},"/forms/{formId}/webhooks/{webhookId}":{"get":{"tags":["Webhook"],"description":"Get webhook details","operationId":"getWebhook","parameters":[{"name":"formId","in":"path","description":"The ID of the form","required":true,"schema":{"type":"integer"}},{"name":"webhookId","in":"path","description":"The ID of the webhook","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Webhook details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookDetailedApiDto"}}}},"403":{"description":"Forbidden"},"404":{"description":"Webhook not found"}}},"put":{"tags":["Webhook"],"description":"Update an existing webhook","operationId":"updateWebhook","parameters":[{"name":"formId","in":"path","description":"The ID of the form","required":true,"schema":{"type":"integer"}},{"name":"webhookId","in":"path","description":"The ID of the webhook","required":true,"schema":{"type":"integer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EditWebhookInputApiDto"}}}},"responses":{"200":{"description":"Webhook updated","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookDetailedApiDto"}}}},"400":{"description":"Invalid request"},"403":{"description":"Forbidden"},"404":{"description":"Webhook not found"},"500":{"description":"Failed to update webhook"}}},"delete":{"tags":["Webhook"],"description":"Delete a webhook","operationId":"deleteWebhook","parameters":[{"name":"formId","in":"path","description":"The ID of the form","required":true,"schema":{"type":"integer"}},{"name":"webhookId","in":"path","description":"The ID of the webhook","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Webhook deleted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdApiDto"}}}},"403":{"description":"Forbidden"},"404":{"description":"Webhook not found"},"500":{"description":"Failed to delete webhook"}}}},"/forms/{formId}/webhooks/openapi":{"get":{"tags":["Webhook"],"description":"Get OpenAPI definition for a form's webhook","operationId":"getWebhookOpenApi","parameters":[{"name":"formId","in":"path","description":"The ID of the form","required":true,"schema":{"type":"integer"}}],"responses":{"200":{"description":"OpenAPI definition","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookOpenApiDefinitionDto"}}}},"400":{"description":"Bad request"},"403":{"description":"Forbidden"},"404":{"description":"Form not found"}}}}},"components":{"schemas":{"ConfirmationDetailedApiDto":{"title":"Confirmation Details","description":"Confirmation email details response","properties":{"id":{"description":"The ID of the confirmation email","type":"integer","nullable":false},"form":{"description":"ID of the form this confirmation is associated with","type":"integer","nullable":false},"name":{"description":"Name of the confirmation email","type":"string","nullable":true},"toField":{"description":"The form field ID that contains the recipient's email address","type":"integer","nullable":true},"sender":{"description":"Email address of the sender","type":"string","nullable":false},"subject":{"description":"Subject of the confirmation email","type":"string","nullable":false},"message":{"description":"Body content of the confirmation email","type":"string","nullable":false},"delay":{"description":"Delay in minutes before sending the confirmation email","type":"string","nullable":true},"type":{"description":"Type of content (fields|data)","type":"string","nullable":true},"format":{"description":"Format of the confirmation email (e.g., html, plaintext)","type":"string","nullable":true},"hideEmpty":{"description":"Flag to hide empty fields in the confirmation email","type":"string","nullable":true},"logic":{"oneOf":[{"$ref":"#/components/schemas/LogicDto"}],"nullable":true,"description":"Logic conditions for when to send the confirmation email"}},"type":"object"},"ConfirmationEmailPreviewApiDto":{"title":"Confirmation Email Preview","description":"Confirmation Email preview response","properties":{"id":{"description":"The ID of the confirmation email","type":"integer","nullable":false}},"type":"object"},"ConfirmationEmailsListingApiDto":{"title":"Confirmation Emails Listing","description":"Confirmation emails listing response","properties":{"confirmations":{"description":"List of confirmation emails associated with the form","type":"array","items":{"$ref":"#/components/schemas/ConfirmationDetailedApiDto"},"nullable":true}},"type":"object"},"CreateConfirmationEmailInputApiDto":{"title":"Create Confirmation Email","description":"Create confirmation email request","properties":{"name":{"description":"Name of the confirmation email","type":"string","nullable":true},"toField":{"description":"Form field ID that contains the recipient's email address","type":"integer","nullable":false},"senderEmail":{"description":"Email address of the sender","type":"string","nullable":false},"subject":{"description":"Subject line of the confirmation email","type":"string","nullable":false},"type":{"description":"Type of content to include in the email message","type":"string","enum":["data","fields"],"nullable":false},"hideEmpty":{"description":"Whether to exclude empty fields from the email","type":"boolean","default":false,"nullable":true},"showSection":{"description":"Whether to display section headings in the email","type":"boolean","default":false,"nullable":true},"message":{"description":"HTML content of the email message","type":"string","nullable":false},"delay":{"description":"Delay before sending email (e.g., '+1 day', '+1 hour', '12/23/2012')","type":"string","nullable":true},"format":{"description":"Whether the Confirmation Email should be Rich HTML or Plain Text","type":"string","default":"html","enum":["html","plaintext"],"nullable":true},"logic":{"oneOf":[{"$ref":"#/components/schemas/LogicDto"}],"nullable":true,"description":"Logic conditions for when to send the confirmation email"}},"type":"object"},"UpdateConfirmationEmailInputApiDto":{"title":"Update Confirmation Email","description":"Update confirmation email request","properties":{"name":{"description":"Name of the confirmation email","type":"string","nullable":true},"toField":{"description":"Form field ID that contains the recipient's email address","type":"integer","nullable":false},"senderEmail":{"description":"Email address of the sender","type":"string","nullable":false},"subject":{"description":"Subject line of the confirmation email","type":"string","nullable":false},"type":{"description":"Type of content to include in the email message","type":"string","enum":["data","fields"],"nullable":false},"hideEmpty":{"description":"Whether to exclude empty fields from the email","type":"boolean","default":false,"nullable":true},"showSection":{"description":"Whether to display section headings in the email","type":"boolean","default":false,"nullable":true},"message":{"description":"HTML content of the email message","type":"string","nullable":true},"delay":{"description":"Delay before sending email (e.g., '+1 day', '+1 hour', '12/23/2012')","type":"string","nullable":true},"format":{"description":"Whether the Confirmation Email should be Rich HTML or Plain Text","type":"string","default":"html","enum":["html","plaintext"],"nullable":true},"logic":{"oneOf":[{"$ref":"#/components/schemas/LogicDto"}],"nullable":true,"description":"Logic conditions for when to send the confirmation email"}},"type":"object"},"NotificationDetailedApiDto":{"title":"Notification Details","description":"Notification email details response","properties":{"id":{"description":"The ID of the notification email","type":"integer","nullable":false},"form":{"description":"ID of the form this notification is associated with","type":"integer","nullable":false},"name":{"description":"Name of the notification email","type":"string","nullable":true},"fromType":{"description":"The type of from address (noreply, custom, field)","type":"string","nullable":false},"fromValue":{"description":"Custom email address or field ID","type":"string","nullable":false},"recipients":{"description":"Email addresses to send notification to","type":"string","nullable":false},"subject":{"description":"Subject of the notification email","type":"string","nullable":false},"type":{"description":"What is included in the message (data, link, or fields)","type":"string","nullable":false},"hideEmpty":{"description":"Flag to not include empty fields in the email","type":"string","nullable":false},"hideHidden":{"description":"Flag to not include hidden fields in the email","type":"boolean","default":false,"nullable":true},"showSection":{"description":"Flag to show section headings in email","type":"string","nullable":false},"message":{"description":"The email message (if type = fields)","type":"string","nullable":true},"attachLimit":{"description":"Only attach files if under this limit (in KBytes)","type":"integer","nullable":true},"format":{"description":"Whether the notification email should be Rich HTML or Plain Text","type":"string","nullable":false},"logic":{"oneOf":[{"$ref":"#/components/schemas/LogicDto"}],"nullable":true,"description":"Logic conditions for when to send the notification email"}},"type":"object"},"NotificationEmailPreviewApiDto":{"title":"Notification Email Preview","description":"Notification email preview response","properties":{"id":{"description":"The ID of the notification email","type":"integer","nullable":false}},"type":"object"},"NotificationEmailsListingApiDto":{"title":"Notification Emails Listing","description":"Notification emails listing response","properties":{"Notifications":{"description":"List of notification emails","type":"array","items":{"$ref":"#/components/schemas/NotificationDetailedApiDto"},"nullable":true}},"type":"object"},"CreateNotificationEmailInputApiDto":{"title":"Create Notification Email","description":"Create notification email request","properties":{"name":{"description":"Name of the notification email","type":"string","nullable":true},"fromType":{"description":"The type of from address (noreply, custom, field)","type":"string","enum":["noreply","custom","field"],"nullable":false},"fromValue":{"description":"Custom email address or field ID","type":"string","nullable":false},"recipients":{"description":"Email addresses to send notification to (split with return character \\n)","type":"string","nullable":false},"subject":{"description":"The subject of the email","type":"string","nullable":false},"type":{"description":"What is included in the message (data, link, or fields)","type":"string","enum":["data","link","fields"],"nullable":false},"hideEmpty":{"description":"Flag to not include empty fields in the email","type":"boolean","default":false,"nullable":true},"hideHidden":{"description":"Flag to not include hidden fields in the email","type":"boolean","default":false,"nullable":true},"showSection":{"description":"Flag to show section headings in email","type":"boolean","default":false,"nullable":true},"message":{"description":"The email message (if type = fields)","type":"string","nullable":true},"attachLimit":{"description":"Only attach files if under this limit (in KBytes)","type":"integer","format":"int32","nullable":true},"format":{"description":"Whether the notification email should be Rich HTML or Plain Text","type":"string","default":"html","enum":["html","plaintext"],"nullable":true},"logic":{"oneOf":[{"$ref":"#/components/schemas/LogicDto"}],"nullable":true,"description":"Logic conditions for when to send the notification email"}},"type":"object"},"UpdateNotificationEmailInputApiDto":{"title":"Update Notification Email","description":"Update notification email request","properties":{"name":{"description":"Name of the notification email","type":"string","nullable":true},"fromType":{"description":"The type of from address (noreply, custom, field)","type":"string","enum":["noreply","custom","field"],"nullable":false},"fromValue":{"description":"Custom email address or field ID","type":"string","nullable":false},"recipients":{"description":"Email addresses to send notification to (split with return character \\n)","type":"string","nullable":false},"subject":{"description":"The subject of the email","type":"string","nullable":false},"type":{"description":"What is included in the message (data, link, or fields)","type":"string","enum":["data","link","fields"],"nullable":false},"hideEmpty":{"description":"Flag to not include empty fields in the email","type":"boolean","default":false,"nullable":true},"hideHidden":{"description":"Flag to not include hidden fields in the email","type":"boolean","default":false,"nullable":true},"showSection":{"description":"Flag to show section headings in email","type":"boolean","default":false,"nullable":true},"message":{"description":"The email message (if type = fields)","type":"string","nullable":true},"attachLimit":{"description":"Only attach files if under this limit (in KBytes)","type":"integer","format":"int32","nullable":true},"format":{"description":"Whether the notification email should be Rich HTML or Plain Text","type":"string","default":"html","enum":["html","plaintext"],"nullable":true},"logic":{"oneOf":[{"$ref":"#/components/schemas/LogicDto"}],"nullable":true,"description":"Logic conditions for when to send the notification email"}},"type":"object"},"DatetimeCalculationApiDto":{"title":"Datetime Calculation","description":"Datetime calculation used for field","properties":{"fieldOneCalculation":{"description":"First field used for calculation (or current_date)","type":"string","nullable":true},"fieldTwoCalculation":{"description":"Second field used for calculation (or current_date)","type":"string","nullable":true},"calculationUnits":{"description":"Units used for calculation (days, months, years)","type":"string","enum":["days","months","years"],"nullable":true},"calculationOperator":{"description":"Operator used for calculation (+, -)","type":"string","enum":["+","-"],"nullable":true},"calculationType":{"description":"Type of calculation","type":"string","enum":["date"],"nullable":true},"calculationAllowNegatives":{"description":"Decide if calculation allow negative value","type":"boolean","nullable":true}},"type":"object"},"NumericCalculationApiDto":{"title":"Numeric Calculation","description":"Numeric calculation used for field","properties":{"label":{"description":"Label for calculation item","type":"string","nullable":false},"type":{"description":"Type of calculation item","type":"string","nullable":false},"value":{"description":"Value used for calculation item (number or ID of used field)","type":"string","nullable":false}},"type":"object"},"FieldDetailedApiDto":{"title":"Field Details","description":"Field details","properties":{"id":{"description":"The ID of the field","type":"integer","nullable":false},"label":{"description":"Label of the field","type":"string","nullable":false},"labelKey":{"description":"Field label as key","type":"string","nullable":false},"internalLabel":{"description":"Internal label of the field","type":"string","nullable":true},"supportingText":{"description":"Description of the field","type":"string","nullable":true},"useCallout":{"description":"Flag to show the description in a callout box","type":"boolean","nullable":true},"type":{"description":"Type of the field","type":"string","nullable":false},"required":{"description":"Flag to mark field as required","type":"boolean","nullable":true},"readOnly":{"description":"Flag to not allow the field to be changed","type":"boolean","nullable":false},"hidden":{"description":"Flag to hide the field","type":"boolean","nullable":false},"unique":{"description":"Flag to mark field as requiring a unique value","type":"boolean","nullable":false},"hideLabel":{"description":"Flag to show or hide the label","type":"boolean","nullable":false},"displayOrder":{"description":"Determines the order in which the field appears on the live form","type":"integer","nullable":false},"columnSpan":{"description":"Determines how many columns this field takes on the live form","type":"integer","nullable":false},"language":{"description":"Language of the field","type":"string","nullable":false},"defaultValue":{"description":"Default value of the field on the live form","type":"string","nullable":false},"smartListId":{"description":"ID of smart list to attach","type":"integer","nullable":true},"logic":{"$ref":"#/components/schemas/LogicApiDto"},"numericCalculations":{"description":"Numeric calculations used for field","type":"array","items":{"$ref":"#/components/schemas/NumericCalculationApiDto"},"nullable":true},"datetimeCalculations":{"$ref":"#/components/schemas/DatetimeCalculationApiDto"},"options":{"description":"Options attached to field","type":"array","items":{"$ref":"#/components/schemas/OptionApiDto"},"nullable":true},"attributes":{"description":"Field attributes component","nullable":true,"oneOf":[{"$ref":"#/components/schemas/TextAttributesApiDto"},{"$ref":"#/components/schemas/TextareaAttributesApiDto"},{"$ref":"#/components/schemas/NameAttributesApiDto"},{"$ref":"#/components/schemas/AddressAttributesApiDto"},{"$ref":"#/components/schemas/EmailAttributesApiDto"},{"$ref":"#/components/schemas/PhoneAttributesApiDto"},{"$ref":"#/components/schemas/NumberAttributesApiDto"},{"$ref":"#/components/schemas/SelectAttributesApiDto"},{"$ref":"#/components/schemas/RadioAttributesApiDto"},{"$ref":"#/components/schemas/CheckboxAttributesApiDto"},{"$ref":"#/components/schemas/CreditCardAttributesApiDto"},{"$ref":"#/components/schemas/DatetimeAttributesApiDto"},{"$ref":"#/components/schemas/FileAttributesApiDto"},{"$ref":"#/components/schemas/TableAttributesApiDto"},{"$ref":"#/components/schemas/TableheaderAttributesApiDto"},{"$ref":"#/components/schemas/TablecellAttributesApiDto"},{"$ref":"#/components/schemas/MatrixAttributesApiDto"},{"$ref":"#/components/schemas/RichtextAttributesApiDto"},{"$ref":"#/components/schemas/EmbedAttributesApiDto"},{"$ref":"#/components/schemas/ProductAttributesApiDto"},{"$ref":"#/components/schemas/SignatureAttributesApiDto"},{"$ref":"#/components/schemas/RatingAttributesApiDto"},{"$ref":"#/components/schemas/SectionAttributesApiDto"}]}},"type":"object"},"AddressAttributesApiDto":{"title":"Address Attributes","description":"Address attributes","properties":{"addressFormat":{"description":"Format of address","type":"string","default":"US","enum":["US","CA","UK","AU","XX"],"nullable":false},"showAddressLine1":{"description":"Use address line 1 subfield","type":"boolean","default":true,"nullable":false},"showAddressLine2":{"description":"Use address line 2 subfield","type":"boolean","default":true,"nullable":false},"showCity":{"description":"Use city subfield","type":"boolean","default":true,"nullable":false},"showState":{"description":"Use state subfield","type":"boolean","default":true,"nullable":false},"showPostalCode":{"description":"Use postal code subfield","type":"boolean","default":true,"nullable":false},"showCountry":{"description":"Use country subfield","type":"boolean","default":false,"nullable":false}},"type":"object"},"CheckboxAttributesApiDto":{"title":"Checkbox Attributes","description":"Checkbox attributes","properties":{"optionsLayout":{"description":"Used options layout - vertical or horizontal","type":"string","default":"vertical","nullable":false},"useOtherOption":{"description":"Add 'Other' option on live form","type":"boolean","default":false,"nullable":false},"randomizeOptions":{"description":"Randomize options on live form","type":"boolean","default":false,"nullable":false},"optionPartToStore":{"description":"Save label, value or both in submissions","type":"string","default":"value","enum":["both","label","value"],"nullable":false},"useLabelsAndValues":{"description":"Use separate labels and values","type":"boolean","default":false,"nullable":false},"useImages":{"description":"Use images as options","type":"boolean","default":false,"nullable":false},"imageDimensions":{"description":"Used dimensions of images","type":"string","default":"customDimensions","enum":["customDimensions","customWidth","customHeight","originalDimensions"],"nullable":false},"imageWidth":{"description":"Width of image option","type":"integer","default":100,"nullable":false},"imageHeight":{"description":"Height of image option","type":"integer","default":100,"nullable":false},"lockImageRatio":{"description":"Keep image ratio","type":"boolean","default":false,"nullable":false},"lockImageOption":{"description":"How to keep ratio of image","type":"string","default":"fitProportionally","enum":["fillSpace","fitProportionally"],"nullable":false},"imageLabelAlignment":{"description":"Where label is in relation to image","type":"string","default":"bottom","enum":["top","right","bottom","left"],"nullable":false},"useCheckAllOption":{"description":"Add 'Check all' option on live form","type":"boolean","default":false,"nullable":false}},"type":"object"},"CreditCardAttributesApiDto":{"title":"Credit Card Attributes","description":"Credit card attributes","properties":{"acceptVisa":{"description":"Decides if field accepts Visa","type":"boolean","default":true,"nullable":false},"acceptMastercard":{"description":"Decides if field accepts Mastercard","type":"boolean","default":true,"nullable":false},"acceptAmericanExpress":{"description":"Decides if field accepts American Express","type":"boolean","default":true,"nullable":false},"acceptDiscover":{"description":"Decides if field accepts Discover","type":"boolean","default":true,"nullable":false},"acceptDinersClub":{"description":"Decides if field accepts Diners Club","type":"boolean","default":false,"nullable":false},"acceptJcb":{"description":"Decides if field accepts JCB","type":"boolean","default":false,"nullable":false}},"type":"object"},"DatetimeAttributesApiDto":{"title":"Datetime Attributes","description":"Datetime attributes","properties":{"dateFormat":{"description":"Format for displaying the date","type":"string","default":"M d, Y","enum":["","m/d/y","m/d/YY","M d, Y","F d, Y","d/m/y","d/m/YY","d M Y","d F Y","YY-m-d","M Y"],"nullable":false},"timeFormat":{"description":"Format for displaying the time","type":"string","default":"h:i A","enum":["","H,i","H,i,s","h,i A","h,i,s A"],"nullable":false},"allowedYearsPlus":{"description":"Number of future years to show","type":"integer","default":5,"nullable":true},"allowedYearsMinus":{"description":"Number of previous years to show","type":"integer","default":5,"nullable":true},"disableDatesAfter":{"description":"Disable dates after this date","type":"string","default":"","nullable":true}},"type":"object"},"EmailAttributesApiDto":{"title":"Email Attributes","description":"Email attributes","properties":{"maxLength":{"description":"Maximum length of email","type":"integer","default":0,"nullable":true},"placeholder":{"description":"Placeholder text on the live form","type":"string","default":"","nullable":true},"requireConfirmation":{"description":"Is input confirmation required on the live form","type":"boolean","default":false,"nullable":false},"confirmationText":{"description":"Label of confirmation input","type":"string","default":"","nullable":true}},"type":"object"},"EmbedAttributesApiDto":{"title":"Embed Code Attributes","description":"Embed code attributes","properties":{"text":{"description":"Text provided to embed field","type":"string","nullable":true}},"type":"object"},"FileAttributesApiDto":{"title":"File Attributes","description":"File attributes","properties":{"allowedTypes":{"description":"Allowed file types for this field","type":"string","default":"jpg,jpeg,gif,png,bmp,tif,psd,pdf,doc,docx,xls,xlsx,txt,mp3,mp4,aac,wav,au,wmv,avi,mpg,mpeg,zip,gz,rar,z,tgz,tar,sitx","enum":["jpg","jpeg","gif","png","bmp","tif","psd","pdf","doc","docx","xls","xlsx","txt","mp3","mp4","aac","wav","au","wmv","avi","mpg","mpeg","zip","gz","rar","z","tgz","tar","sitx"],"nullable":false},"minFileSize":{"description":"Minimum size of a uploaded file","type":"integer","default":0,"minimum":0,"nullable":false},"maxFileSize":{"description":"Maximum size of a uploaded file","type":"integer","default":10,"minimum":1,"nullable":false},"allowMultipleFiles":{"description":"Decides if multiple files are allowed in upload","type":"boolean","default":false,"nullable":false},"fileLimit":{"description":"Limit of uploaded files","type":"integer","default":10,"maximum":20,"minimum":1,"nullable":false}},"type":"object"},"MatrixColumnApiDto":{"title":"Matrix Column","description":"Matrix column","properties":{"label":{"description":"Column label in matrix field","type":"string","nullable":false}},"type":"object"},"MatrixRowApiDto":{"title":"Matrix Row","description":"Matrix row","properties":{"label":{"description":"Row label in matrix field","type":"string","nullable":false}},"type":"object"},"MatrixAttributesApiDto":{"title":"Matrix Attributes","description":"Matrix attributes","properties":{"rows":{"description":"Row choices in matrix field","type":"array","items":{"$ref":"#/components/schemas/MatrixRowApiDto"},"nullable":false},"columns":{"description":"Column choices in matrix field","type":"array","items":{"$ref":"#/components/schemas/MatrixColumnApiDto"},"nullable":false},"oneChoicePerRow":{"description":"Decides if user is allowed to choose only one option in row","type":"boolean","default":true,"nullable":false},"oneChoicePerColumn":{"description":"Decides if user is allowed to choose only one option in column","type":"boolean","default":false,"nullable":false},"randomizeRows":{"description":"Decides if rows are randomized on live form","type":"boolean","default":false,"nullable":false}},"type":"object"},"NameAttributesApiDto":{"title":"Name Attributes","description":"Name attributes","properties":{"showInitial":{"description":"Use initial subfield","type":"boolean","default":false,"nullable":false},"showMiddle":{"description":"Use middle name subfield","type":"boolean","default":false,"nullable":false},"showPrefix":{"description":"Use prefix subfield","type":"boolean","default":false,"nullable":false},"showSuffix":{"description":"Use suffix subfield","type":"boolean","default":false,"nullable":false}},"type":"object"},"NumberAttributesApiDto":{"title":"Number Attributes","description":"Number attributes","properties":{"minValue":{"description":"Minimum value of field","type":"integer","nullable":true},"maxValue":{"description":"Maximum value of field","type":"integer","nullable":true},"placeholder":{"description":"Placeholder text on live form","type":"string","nullable":true},"decimalPlaces":{"description":"Decimal places used in formatting","type":"integer","default":0,"nullable":false},"useSlider":{"description":"Use slider to pick value","type":"boolean","default":false,"nullable":false},"currency":{"description":"Currency used in formatting","type":"integer","default":"","enum":["","local","AFN","DZD","ARS","AMD","AWG","AUD","AZN","BSD","BHD","THB","PAB","BBD","BYR","BYN","BZD","BMD","VEF","BOB","BRL","BND","BGN","CAD","KYD","CLP","COP","BAM","NIO","CRC","HRK","CUP","CZK","DKK","MKD","DOP","VND","XCD","EGP","SVC","EEK","EUR","FKP","FJD","HUF","GHC","GIP","PYG","GGP","GYD","HKD","UAH","ISK","INR","IRR","IQD","JMD","JEP","JOD","KES","LAK","KWD","LVL","LBP","ALL","HNL","LRD","LYD","LTL","MYR","IMP","MUR","MXN","MAD","MZN","NGN","NAD","NPR","ANG","ILS","RON","TWD","NZD","KPW","NOK","PEN","PKR","UYU","PHP","GBP","BWP","QAR","GTQ","ZAR","OMR","KHR","IDR","RUB","RUR","SHP","SAR","RSD","SCR","SGD","SBD","KGS","SOS","LKR","SRD","SEK","SYP","TZS","KZT","TTD","MNT","TND","TRL","TRY","AED","USD","UGX","UZS","KRW","YER","JPY","CNY","ZWD","PLN"],"nullable":false}},"type":"object"},"PhoneAttributesApiDto":{"title":"Phone Attributes","description":"Phone attributes response","properties":{"phoneFormat":{"description":"Phone format","type":"string","default":"national","enum":["user","international","national"],"nullable":true},"countryFormat":{"description":"Country phone format","type":"string","default":"US","enum":["AD","AE","AF","AG","AI","AL","AM","AO","AR","AS","AT","AU","AW","AX","AZ","BA","BB","BD","BE","BF","BG","BH","BI","BJ","BL","BM","BN","BO","BQ","BR","BS","BT","BW","BY","BZ","CA","CC","CD","CF","CG","CH","CI","CK","CL","CM","CN","CO","CR","CU","CV","CW","CX","CY","CZ","DE","DJ","DK","DM","DO","DZ","EC","EE","EG","EH","ER","ES","ET","FI","FJ","FK","FM","FO","FR","GA","UK","GD","GE","GF","GG","GH","GI","GL","GM","GN","GP","GQ","GR","GT","GU","GW","GY","HK","HN","HR","HT","HU","ID","IE","IL","IM","IN","IO","IQ","IR","IS","IT","JE","JM","JO","JP","KE","KG","KH","KI","KM","KN","KP","KR","KW","KY","KZ","LA","LB","LC","LI","LK","LR","LS","LT","LU","LV","LY","MA","MC","MD","ME","MF","MG","MH","MK","ML","MM","MN","MO","MP","MQ","MR","MS","MT","MU","MV","MW","MX","MY","MZ","NA","NC","NE","NF","NG","NI","NL","NO","NP","NR","NU","NZ","OM","PA","PE","PF","PG","PH","PK","PL","PM","PR","PS","PT","PW","PY","QA","RE","RO","RS","RU","RW","SA","SB","SC","SD","SE","SG","SH","SI","SJ","SK","SL","SM","SN","SO","SR","SS","ST","SV","SX","SY","SZ","TC","TD","TG","TH","TJ","TK","TL","TM","TN","TO","TR","TT","TV","TW","TZ","UA","UG","US","UY","UZ","VA","VC","VE","VG","VI","VN","VU","WF","WS","YE","YT","ZA","ZM","ZW","XX"],"nullable":true},"placeholder":{"description":"Placeholder phone on live form","type":"string","default":"","nullable":true}},"type":"object"},"ProductAttributesApiDto":{"title":"Product Attributes","description":"Event/Product attributes","properties":{"eventDescription":{"description":"Description of an event/product","type":"string","default":"Event description goes here...","nullable":true},"chargeType":{"description":"Type of charge for an event","type":"string","default":"fixed_amount","enum":["fixed_amount","no_charge"],"nullable":true},"currency":{"description":"Currency used in price","type":"string","default":"local","enum":["","local","AFN","DZD","ARS","AMD","AWG","AUD","AZN","BSD","BHD","THB","PAB","BBD","BYR","BYN","BZD","BMD","VEF","BOB","BRL","BND","BGN","CAD","KYD","CLP","COP","BAM","NIO","CRC","HRK","CUP","CZK","DKK","MKD","DOP","VND","XCD","EGP","SVC","EEK","EUR","FKP","FJD","HUF","GHC","GIP","PYG","GGP","GYD","HKD","UAH","ISK","INR","IRR","IQD","JMD","JEP","JOD","KES","LAK","KWD","LVL","LBP","ALL","HNL","LRD","LYD","LTL","MYR","IMP","MUR","MXN","MAD","MZN","NGN","NAD","NPR","ANG","ILS","RON","TWD","NZD","KPW","NOK","PEN","PKR","UYU","PHP","GBP","BWP","QAR","GTQ","ZAR","OMR","KHR","IDR","RUB","RUR","SHP","SAR","RSD","SCR","SGD","SBD","KGS","SOS","LKR","SRD","SEK","SYP","TZS","KZT","TTD","MNT","TND","TRL","TRY","AED","USD","UGX","UZS","KRW","YER","JPY","CNY","ZWD","PLN"],"nullable":true},"image":{"description":"Image used to describe event/product","type":"string","nullable":true},"inventoryMode":{"description":"Inventory mode - track or unlimited","type":"string","default":"unlimited","enum":["track","unlimited"],"nullable":true},"inventory":{"description":"Amount of available items","type":"integer","nullable":true},"unitPrice":{"description":"Price of a single unit","type":"number","format":"float","default":3.99,"minimum":0,"nullable":true},"minQuantity":{"description":"Minimum quantity to purchase","type":"integer","default":1,"minimum":1,"nullable":true},"maxQuantity":{"description":"Maximum quantity to purchase","type":"integer","default":1,"minimum":1,"nullable":true},"soldoutAction":{"description":"The action to take when the event/product is sold out","type":"integer","default":"message","enum":["hide_field","message","waitlist"],"nullable":true},"isSoldout":{"description":"Decides if the event/product is sold out","type":"integer","nullable":true},"displayInSubmission":{"description":"Decides what should be displayed in the submission","type":"integer","default":"default","enum":["default","quantity","total"],"nullable":true}},"type":"object"},"RadioAttributesApiDto":{"title":"Radio Attributes","description":"Radio attributes","properties":{"optionsLayout":{"description":"Used options layout - vertical or horizontal","type":"string","default":"vertical","nullable":false},"useOtherOption":{"description":"Add 'Other' option on live form","type":"boolean","default":false,"nullable":false},"randomizeOptions":{"description":"Randomize options on live form","type":"boolean","default":false,"nullable":false},"optionPartToStore":{"description":"Save label, value or both in submissions","type":"string","default":"value","enum":["both","label","value"],"nullable":false},"useLabelsAndValues":{"description":"Use separate labels and values","type":"boolean","default":false,"nullable":false},"useImages":{"description":"Use images as options","type":"boolean","default":false,"nullable":false},"imageDimensions":{"description":"Used dimensions of images","type":"string","default":"customDimensions","enum":["customDimensions","customWidth","customHeight","originalDimensions"],"nullable":false},"imageWidth":{"description":"Width of image option","type":"integer","default":100,"nullable":false},"imageHeight":{"description":"Height of image option","type":"integer","default":100,"nullable":false},"lockImageRatio":{"description":"Keep image ratio","type":"boolean","default":false,"nullable":false},"lockImageOption":{"description":"How to keep ratio of image","type":"string","default":"fitProportionally","enum":["fillSpace","fitProportionally"],"nullable":false},"imageLabelAlignment":{"description":"Where label is in relation to image","type":"string","default":"bottom","enum":["top","right","bottom","left"],"nullable":false}},"type":"object"},"RatingAttributesApiDto":{"title":"Rating Attributes","description":"Rating attributes","properties":{"addNAButton":{"description":"Decides if N/A option is added on live form","type":"boolean","default":false,"nullable":true},"allowHalfRatings":{"description":"Decides if half rating is allowed","type":"boolean","nullable":true},"count":{"description":"Count of ratings","type":"integer","default":5,"nullable":true},"icon":{"description":"Icon used on live form","type":"string","default":"star","enum":["star","heart"],"nullable":true}},"type":"object"},"RichtextAttributesApiDto":{"title":"Richtext Attributes","description":"Description area attributes","properties":{"text":{"description":"Text provided to description area","type":"string","default":"","nullable":true},"textEditor":{"description":"Text editor used to provide text to description area","type":"string","default":"wysiwyg","nullable":false}},"type":"object"},"SectionAttributesApiDto":{"title":"Section Attributes","description":"Section attributes","properties":{"startNewPage":{"description":"Decides if this section should start new page on live form","type":"boolean","default":false,"nullable":true},"heading":{"description":"Heading of the section","type":"string","default":"","nullable":true},"text":{"description":"Text provided to section","type":"string","default":"","nullable":true},"textEditor":{"description":"Text editor used to provide text to section","type":"string","nullable":false},"fieldLabelsPosition":{"description":"Decides where field label is placed on live form in this section","type":"string","default":"default","enum":["default","top","left"],"nullable":false},"numberOfColumns":{"description":"Number of visible columns in the form","type":"integer","default":0,"nullable":false}},"type":"object"},"SelectAttributesApiDto":{"title":"Select Attributes","description":"Select attributes","properties":{"rowsDisplayed":{"description":"Rows of options displayed on live form","type":"integer","default":1,"nullable":false},"useFirstOptionAsPlaceholder":{"description":"Show first option as placeholder","type":"boolean","default":false,"nullable":false},"randomizeOptions":{"description":"Randomize options on live form","type":"boolean","default":false,"nullable":false},"optionPartToStore":{"description":"Save label, value or both in submissions","type":"string","default":"value","enum":["both","label","value"],"nullable":false},"useLabelsAndValues":{"description":"Use separate labels and values","type":"boolean","default":false,"nullable":false},"useSearchableOptions":{"description":"Search options on live form","type":"string","default":false,"nullable":false}},"type":"object"},"SignatureAttributesApiDto":{"title":"Signature Attributes","description":"Signature attributes"},"TableColumnApiDto":{"title":"Table Column","description":"Table column","properties":{"id":{"description":"Column ID in table field","type":"integer","nullable":false},"label":{"description":"Column label in table field","type":"string","nullable":false},"type":{"description":"Column type in table field","type":"string","default":"text","enum":["text","textarea","email","phone","number","select"],"nullable":false}},"type":"object"},"TableRowApiDto":{"title":"Table Row","description":"Table row","properties":{"label":{"description":"Row label in table field","type":"string","nullable":false},"key":{"description":"Row key in table field","type":"string","nullable":false}},"type":"object"},"TableAttributesApiDto":{"title":"Table Attributes","description":"Table attributes","properties":{"columns":{"description":"Columns of table","type":"array","items":{"$ref":"#/components/schemas/TableColumnApiDto"},"nullable":false},"rows":{"description":"Rows of table","type":"array","items":{"$ref":"#/components/schemas/TableRowApiDto"},"nullable":false}},"type":"object"},"TablecellAttributesApiDto":{"title":"Tablecell Attributes","description":"Table cell attributes","properties":{"parentTableId":{"description":"ID of the table","type":"integer","nullable":false},"parentTableheaderId":{"description":"ID of the tableheader","type":"integer","nullable":false},"parentRowKey":{"description":"Key of the row","type":"integer","nullable":false}},"type":"object"},"TableheaderAttributesApiDto":{"title":"Tableheader Attributes","description":"Table header attributes","properties":{"parentTableId":{"description":"ID of the table","type":"integer","nullable":false},"columnWidthType":{"description":"Type of column width - auto or percent","type":"string","default":"auto","enum":["auto","percent"],"nullable":false},"columnWidth":{"description":"Column width in percent","type":"integer","default":25,"maximum":100,"minimum":0,"nullable":false},"columnFieldType":{"description":"Field type of column","type":"string","default":"text","nullable":false},"columnFieldTypeAttributes":{"description":"Column field types attributes component","nullable":true,"oneOf":[{"$ref":"#/components/schemas/TextAttributesApiDto"},{"$ref":"#/components/schemas/TextareaAttributesApiDto"},{"$ref":"#/components/schemas/EmailAttributesApiDto"},{"$ref":"#/components/schemas/PhoneAttributesApiDto"},{"$ref":"#/components/schemas/NumberAttributesApiDto"},{"$ref":"#/components/schemas/SelectAttributesApiDto"}]}},"type":"object"},"TextAttributesApiDto":{"title":"Text Attributes","description":"Text attributes","properties":{"minLength":{"description":"Minimum length of text","type":"integer","default":0,"minimum":0,"nullable":true},"maxLength":{"description":"Maximum length of text","type":"integer","default":0,"minimum":1,"nullable":true},"placeholder":{"description":"Placeholder text on the live form","type":"string","nullable":true},"restrictDataAccess":{"description":"Is data restricted for other users","type":"boolean","default":false,"nullable":false},"hideInputCharacters":{"description":"Is provided text hidden on the live form","type":"boolean","default":false,"nullable":false},"removeDataFromEmailsAndExports":{"description":"Is data removed from emails and exports","type":"boolean","default":false,"nullable":false},"requireConfirmation":{"description":"Is input confirmation required on the live form","type":"boolean","default":false,"nullable":false},"confirmationText":{"description":"Label of confirmation input","type":"string","default":"","nullable":true}},"type":"object"},"TextareaAttributesApiDto":{"title":"Textarea Attributes","description":"Textarea attributes","properties":{"minLength":{"description":"Minimum length of text","type":"integer","default":0,"nullable":true},"maxLength":{"description":"Maximum length of text","type":"integer","default":0,"nullable":true},"rows":{"description":"Rows number of text","type":"integer","default":10,"nullable":false},"placeholder":{"description":"Placeholder text on live form","type":"string","default":"","nullable":true}},"type":"object"},"LogicApiDto":{"title":"Logic","description":"Logic for the field","properties":{"action":{"description":"Action of logic","type":"string","nullable":false},"operator":{"description":"Operator of logic","type":"string","nullable":false},"fields":{"description":"Fields used for logic","type":"array","items":{"$ref":"#/components/schemas/LogicFieldApiDto"},"nullable":true}},"type":"object"},"LogicFieldApiDto":{"title":"LogicField","description":"Field used in logic","properties":{"comparisonOperator":{"description":"Type of comparison operator used for logic","type":"string","nullable":false},"fieldId":{"description":"Id of field used for logic","type":"string","nullable":false},"value":{"description":"Value of field used for logic","type":"string","nullable":false}},"type":"object"},"OptionApiDto":{"title":"Option","description":"Options attached to field","properties":{"label":{"description":"Label of option","type":"string","nullable":false},"value":{"description":"Value of option","type":"string","nullable":false},"imageUrl":{"description":"URL of image for option","type":"string","nullable":false}},"type":"object"},"FieldPreviewApiDto":{"title":"Field Preview","description":"Field preview response","properties":{"id":{"description":"The ID of the field","type":"integer","nullable":false},"label":{"description":"Label of the field","type":"string","nullable":false},"labelKey":{"description":"Field label as key","type":"string","nullable":false},"internalLabel":{"description":"Internal label of the field","type":"string","nullable":true},"supportingText":{"description":"Description of the field","type":"string","nullable":true},"useCallout":{"description":"Flag to show the description in a callout box","type":"boolean","nullable":true},"type":{"description":"Type of the field","type":"string","nullable":false},"required":{"description":"Flag to mark field as required","type":"boolean","nullable":true},"readOnly":{"description":"Flag to not allow the field to be changed","type":"boolean","nullable":false},"hidden":{"description":"Flag to hide the field","type":"boolean","nullable":false},"unique":{"description":"Flag to mark field as requiring a unique value","type":"boolean","nullable":false},"hideLabel":{"description":"Flag to show or hide the label","type":"boolean","nullable":false},"displayOrder":{"description":"Determines the order in which the field appears on the live form","type":"integer","nullable":false},"columnSpan":{"description":"Determines how many columns this field takes on the live form","type":"integer","nullable":false},"language":{"description":"Language of the field","type":"string","nullable":false},"defaultValue":{"description":"Default value of the field on the live form","type":"string","nullable":false},"smartListId":{"description":"ID of smart list to attach","type":"integer","nullable":true},"logic":{"$ref":"#/components/schemas/LogicApiDto"},"numericCalculations":{"description":"Numeric calculations used for field","type":"array","items":{"$ref":"#/components/schemas/NumericCalculationApiDto"},"nullable":true},"datetimeCalculations":{"$ref":"#/components/schemas/DatetimeCalculationApiDto"},"options":{"description":"Options attached to field","type":"array","items":{"$ref":"#/components/schemas/OptionApiDto"},"nullable":true},"attributes":{"description":"Field attributes component","nullable":true,"oneOf":[{"$ref":"#/components/schemas/TextAttributesApiDto"},{"$ref":"#/components/schemas/TextareaAttributesApiDto"},{"$ref":"#/components/schemas/NameAttributesApiDto"},{"$ref":"#/components/schemas/AddressAttributesApiDto"},{"$ref":"#/components/schemas/EmailAttributesApiDto"},{"$ref":"#/components/schemas/PhoneAttributesApiDto"},{"$ref":"#/components/schemas/NumberAttributesApiDto"},{"$ref":"#/components/schemas/SelectAttributesApiDto"},{"$ref":"#/components/schemas/RadioAttributesApiDto"},{"$ref":"#/components/schemas/CheckboxAttributesApiDto"},{"$ref":"#/components/schemas/CreditCardAttributesApiDto"},{"$ref":"#/components/schemas/DatetimeAttributesApiDto"},{"$ref":"#/components/schemas/FileAttributesApiDto"},{"$ref":"#/components/schemas/TableAttributesApiDto"},{"$ref":"#/components/schemas/TableheaderAttributesApiDto"},{"$ref":"#/components/schemas/TablecellAttributesApiDto"},{"$ref":"#/components/schemas/MatrixAttributesApiDto"},{"$ref":"#/components/schemas/RichtextAttributesApiDto"},{"$ref":"#/components/schemas/EmbedAttributesApiDto"},{"$ref":"#/components/schemas/ProductAttributesApiDto"},{"$ref":"#/components/schemas/SignatureAttributesApiDto"},{"$ref":"#/components/schemas/RatingAttributesApiDto"},{"$ref":"#/components/schemas/SectionAttributesApiDto"}]}},"type":"object"},"FieldsListingApiDto":{"title":"Field Listing","description":"Field listing response","properties":{"fields":{"description":"Preview of fields in list","type":"array","items":{"$ref":"#/components/schemas/FieldPreviewApiDto"},"nullable":true}},"type":"object"},"CreateFieldInputApiDto":{"title":"Create Field","description":"Create Field request","properties":{"label":{"description":"Label of the field","type":"string","nullable":false},"type":{"description":"Type of the field","type":"string","default":"text","enum":["text","textarea","checkbox","radio","select","number","name","email","phone","address","file","datetime","matrix","product","creditcard","signature","embed","richtext","rating","table","section"],"nullable":false},"internalLabel":{"description":"Internal label of the field","type":"string","nullable":true},"supportingText":{"description":"Description of the field","type":"string","nullable":true},"useCallout":{"description":"Flag to show the description in a callout box","type":"boolean","default":false,"nullable":true},"required":{"description":"Flag to mark field as required","type":"boolean","default":false,"nullable":true},"readOnly":{"description":"Flag to not allow the field to be changed","type":"boolean","default":false,"nullable":true},"hidden":{"description":"Flag to hide the field","type":"boolean","default":false,"nullable":true},"unique":{"description":"Flag to mark field as requiring a unique value","type":"boolean","default":false,"nullable":true},"hideLabel":{"description":"Flag to show or hide the label","type":"boolean","default":false,"nullable":true},"columnSpan":{"description":"Determines how many columns this field takes on the live form","type":"integer","default":1,"nullable":true},"language":{"description":"Language of the field","type":"string","default":"default","enum":["default","af","sq","ar","bg","zh","zh-TW","hr","cs","da","nl","en","fi","fr","de","el","he","hu","is","id","it","ja","kk","ko","no","pl","pt","ro","ru","es","sk","sl","sv","th","tr","vi","cy"],"nullable":true},"defaultValue":{"description":"Default value of the field on the live form","type":"string","nullable":true},"options":{"description":"Options attached to field","type":"array","items":{"$ref":"#/components/schemas/OptionApiDto"},"nullable":true},"smartListId":{"description":"ID of smart list to attach","type":"integer","nullable":true},"unlinkSmartList":{"description":"Flag to unlink smart list from field","type":"boolean","nullable":true},"attributes":{"description":"Field attributes component","nullable":true,"oneOf":[{"$ref":"#/components/schemas/TextAttributesApiDto"},{"$ref":"#/components/schemas/TextareaAttributesApiDto"},{"$ref":"#/components/schemas/NameAttributesApiDto"},{"$ref":"#/components/schemas/AddressAttributesApiDto"},{"$ref":"#/components/schemas/EmailAttributesApiDto"},{"$ref":"#/components/schemas/PhoneAttributesApiDto"},{"$ref":"#/components/schemas/NumberAttributesApiDto"},{"$ref":"#/components/schemas/SelectAttributesApiDto"},{"$ref":"#/components/schemas/RadioAttributesApiDto"},{"$ref":"#/components/schemas/CheckboxAttributesApiDto"},{"$ref":"#/components/schemas/CreditCardAttributesApiDto"},{"$ref":"#/components/schemas/DatetimeAttributesApiDto"},{"$ref":"#/components/schemas/FileAttributesApiDto"},{"$ref":"#/components/schemas/TableAttributesApiDto"},{"$ref":"#/components/schemas/MatrixAttributesApiDto"},{"$ref":"#/components/schemas/RichtextAttributesApiDto"},{"$ref":"#/components/schemas/EmbedAttributesApiDto"},{"$ref":"#/components/schemas/ProductAttributesApiDto"},{"$ref":"#/components/schemas/SignatureAttributesApiDto"},{"$ref":"#/components/schemas/RatingAttributesApiDto"},{"$ref":"#/components/schemas/SectionAttributesApiDto"}]},"logic":{"oneOf":[{"$ref":"#/components/schemas/LogicDto"}],"nullable":true,"description":"Field logic conditions for conditional processing","type":"object"},"numericCalculation":{"oneOf":[{"$ref":"#/components/schemas/NumericCalculationDto"}],"nullable":true,"description":"Numeric calculation definition for this field","type":"object"},"datetimeCalculation":{"oneOf":[{"$ref":"#/components/schemas/DatetimeCalculationDto"}],"nullable":true,"description":"Datetime calculation definition for this field","type":"object"}},"type":"object"},"EditFieldInputApiDto":{"title":"Edit Field","description":"Edit Field request","properties":{"label":{"description":"Label of the field","type":"string","nullable":true},"type":{"description":"Type of the field","type":"string","enum":["text","textarea","checkbox","radio","select","number","name","email","phone","address","file","datetime","matrix","product","creditcard","signature","embed","richtext","rating","table","tableheader","section"],"nullable":true},"internalLabel":{"description":"Internal label of the field","type":"string","nullable":true},"supportingText":{"description":"Description of the field","type":"string","nullable":true},"useCallout":{"description":"Flag to show the description in a callout box","type":"boolean","default":false,"nullable":true},"required":{"description":"Flag to mark field as required","type":"boolean","default":false,"nullable":true},"readOnly":{"description":"Flag to not allow the field to be changed","type":"boolean","default":false,"nullable":true},"hidden":{"description":"Flag to hide the field","type":"boolean","default":false,"nullable":true},"unique":{"description":"Flag to mark field as requiring a unique value","type":"boolean","default":false,"nullable":true},"hideLabel":{"description":"Flag to show or hide the label","type":"boolean","default":false,"nullable":true},"columnSpan":{"description":"Determines how many columns this field takes on the live form","type":"integer","default":1,"nullable":true},"language":{"description":"Language of the field","type":"string","default":"default","enum":["default","af","sq","ar","bg","zh","zh-TW","hr","cs","da","nl","en","fi","fr","de","el","he","hu","is","id","it","ja","kk","ko","no","pl","pt","ro","ru","es","sk","sl","sv","th","tr","vi","cy"],"nullable":true},"defaultValue":{"description":"Default value of the field on the live form","type":"string","nullable":true},"options":{"description":"Options attached to field","type":"array","items":{"$ref":"#/components/schemas/OptionApiDto"},"nullable":true},"smartListId":{"description":"ID of smart list to attach","type":"integer","nullable":true},"unlinkSmartList":{"description":"Flag to unlink smart list from field","type":"boolean","nullable":true},"attributes":{"description":"Field attributes component","nullable":true,"oneOf":[{"$ref":"#/components/schemas/TextAttributesApiDto"},{"$ref":"#/components/schemas/TextareaAttributesApiDto"},{"$ref":"#/components/schemas/NameAttributesApiDto"},{"$ref":"#/components/schemas/AddressAttributesApiDto"},{"$ref":"#/components/schemas/EmailAttributesApiDto"},{"$ref":"#/components/schemas/PhoneAttributesApiDto"},{"$ref":"#/components/schemas/NumberAttributesApiDto"},{"$ref":"#/components/schemas/SelectAttributesApiDto"},{"$ref":"#/components/schemas/RadioAttributesApiDto"},{"$ref":"#/components/schemas/CheckboxAttributesApiDto"},{"$ref":"#/components/schemas/CreditCardAttributesApiDto"},{"$ref":"#/components/schemas/DatetimeAttributesApiDto"},{"$ref":"#/components/schemas/FileAttributesApiDto"},{"$ref":"#/components/schemas/TableAttributesApiDto"},{"$ref":"#/components/schemas/TableheaderAttributesApiDto"},{"$ref":"#/components/schemas/MatrixAttributesApiDto"},{"$ref":"#/components/schemas/RichtextAttributesApiDto"},{"$ref":"#/components/schemas/EmbedAttributesApiDto"},{"$ref":"#/components/schemas/ProductAttributesApiDto"},{"$ref":"#/components/schemas/SignatureAttributesApiDto"},{"$ref":"#/components/schemas/RatingAttributesApiDto"},{"$ref":"#/components/schemas/SectionAttributesApiDto"}]},"logic":{"oneOf":[{"$ref":"#/components/schemas/LogicDto"}],"nullable":true,"description":"Field logic conditions for conditional processing","type":"object"},"numericCalculation":{"oneOf":[{"$ref":"#/components/schemas/NumericCalculationDto"}],"nullable":true,"description":"Numeric calculation definition for this field","type":"object"},"datetimeCalculation":{"oneOf":[{"$ref":"#/components/schemas/DatetimeCalculationDto"}],"nullable":true,"description":"Datetime calculation definition for this field","type":"object"}},"type":"object"},"FolderDetailedApiDto":{"title":"Folder Detailed","description":"Folder detailed response","properties":{"id":{"description":"ID of the folder","type":"integer","nullable":false},"name":{"description":"Name of the folder","type":"string","nullable":false},"parent":{"description":"Parent of the folder","type":"string","nullable":false},"permissions":{"description":"Permissions of the folder","type":"string","nullable":false},"subfolders":{"description":"Direct subfolders visible to the caller (one level; populate via Folder::setSubfolders before copyFrom)","type":"array","items":{"$ref":"#/components/schemas/FolderSubfolderApiDto"},"nullable":false}},"type":"object"},"FolderIdApiDto":{"title":"Folder Id","description":"Folder ID response","properties":{"id":{"description":"ID of the folder","type":"integer","nullable":false}},"type":"object"},"FolderSubfolderApiDto":{"title":"Folder subfolder entry","description":"Direct child folder (no deeper nesting in the API)","properties":{"id":{"description":"ID of the folder","type":"integer","nullable":false},"name":{"description":"Name of the folder","type":"string","nullable":false},"parent":{"description":"Parent of the folder","type":"string","nullable":false},"permissions":{"description":"Permissions of the folder","type":"string","nullable":false}},"type":"object"},"FolderPreviewApiDto":{"title":"Folder Preview","description":"Folder preview response","properties":{"id":{"description":"ID of the folder","type":"integer","nullable":false},"name":{"description":"Name of the folder","type":"string","nullable":false}},"type":"object"},"FoldersListingApiDto":{"title":"Folders Listing","description":"Folders listing response","properties":{"page":{"$ref":"#/components/schemas/PaginationApiDto"},"folders":{"description":"Previews of folders in list","type":"array","items":{"$ref":"#/components/schemas/FolderPreviewApiDto"},"nullable":true}},"type":"object"},"CreateFolderInputApiDto":{"title":"Create Folder","description":"Create Folder request","required":["name"],"properties":{"name":{"description":"Name of the folder","type":"string","nullable":false},"parent":{"description":"Parent folder ID (optional, defaults to root level)","type":"integer","nullable":true}},"type":"object"},"EditFolderInputApiDto":{"title":"Edit Folder","description":"Edit Folder request","properties":{"name":{"description":"Name of the folder","type":"string","nullable":true}},"type":"object"},"FormDetailedApiDto":{"title":"Form Details","description":"Form details response","properties":{"id":{"description":"The ID of the form","type":"integer","nullable":false},"name":{"description":"Name of the form","type":"string","nullable":true},"viewKey":{"description":"View key of the form","type":"string","nullable":false},"folder":{"description":"ID of the folder where the form is located","type":"integer","nullable":true},"version":{"description":"Version of the form","type":"integer","nullable":false},"url":{"description":"URL of the live form","type":"string","nullable":false},"submissionsCount":{"description":"Count of form submissions","type":"integer","nullable":false},"unreadSubmissionsCount":{"description":"Count of unread form submissions","type":"integer","nullable":false},"todaySubmissionsCount":{"description":"Count of today's form submissions","type":"integer","nullable":false},"isEncrypted":{"description":"Is form encrypted","type":"boolean","nullable":false},"submitButtonTitle":{"description":"Title of submit button on live form","type":"string","nullable":false},"isWorkflowForm":{"description":"Is this form a workflow","type":"boolean","nullable":false},"isWorkflowPublished":{"description":"Is this workflow published","type":"boolean","nullable":false},"hasApprovers":{"description":"Whether this form has approvers configured","type":"boolean","nullable":false},"permissions":{"description":"User's permission level for this form","type":"integer","nullable":false},"canEdit":{"description":"Whether the user can edit this form","type":"boolean","nullable":false},"created":{"description":"Date when the form was created","type":"string","nullable":false},"updated":{"description":"Date when the form was last updated","type":"string","nullable":false},"formExtras":{"$ref":"#/components/schemas/FormExtrasApiDto"},"formSettings":{"$ref":"#/components/schemas/FormSettingsApiDto"},"fields":{"description":"Form fields (included when withFields=1)","type":"array","items":{"$ref":"#/components/schemas/FieldPreviewApiDto"},"nullable":true}},"type":"object"},"FormExtrasApiDto":{"title":"Form Extras","description":"Form extras response","properties":{"numberOfColumns":{"description":"Number of visible columns in the form","type":"integer","nullable":false},"fieldLabelsPosition":{"description":"Position where field labels are placed on the live form","type":"string","nullable":false},"language":{"description":"Language of the form","type":"string","nullable":false},"useCaptcha":{"description":"Whether invisible reCAPTCHA is enabled","type":"boolean","nullable":false},"useFieldPrefill":{"description":"Whether field prefill is enabled","type":"boolean","nullable":false},"useSecurityLogo":{"description":"Whether security logo is displayed at the bottom of the live form","type":"boolean","nullable":false},"usePromptForLocation":{"description":"Whether to prompt for location permission on the live form","type":"boolean","nullable":false},"useSaveAndResume":{"description":"Whether save and resume option is enabled on the live form","type":"boolean","nullable":false},"useOneQuestionAtATime":{"description":"Whether the form renders one question at a time","type":"boolean","nullable":false},"showProgressIndicator":{"description":"Whether to show progress indicator","type":"boolean","nullable":false},"skipValidationBetweenPages":{"description":"Whether the form should skip validation between pages","type":"boolean","nullable":false}},"type":"object"},"FormHtmlApiDto":{"title":"Form HTML","description":"Form HTML response","properties":{"id":{"description":"The ID of the form","type":"integer","nullable":false},"name":{"description":"Name of the form","type":"string","nullable":false},"html":{"description":"HTML V4 of the form","type":"string","nullable":false}},"type":"object"},"FormSettingsApiDto":{"title":"Form Settings","description":"Form settings response","properties":{"alias":{"description":"Alias of the form","type":"string","nullable":false},"timezone":{"description":"Timezone of the form","type":"string","nullable":false},"isActive":{"description":"Flag to make the form active/inactive","type":"boolean","nullable":false},"saveSubmissionsToDatabase":{"description":"Flag to disable or enable submissions to be saved in our database","type":"boolean","nullable":false}},"type":"object"},"FormPreviewApiDto":{"title":"Form Preview","description":"Form preview response","properties":{"id":{"description":"The ID of the form","type":"integer","nullable":false},"name":{"description":"Name of the form","type":"string","nullable":false},"viewKey":{"description":"View key of the form","type":"string","nullable":false},"url":{"description":"URL of the live form","type":"string","nullable":false},"submissionsCount":{"description":"Count of form submissions","type":"integer","nullable":false},"unreadSubmissionsCount":{"description":"Count of unread form submissions","type":"integer","nullable":false},"active":{"description":"Whether the form is active","type":"boolean","nullable":false},"created":{"description":"Date of form creation","type":"string","nullable":false},"updated":{"description":"Date of last update","type":"string","nullable":false},"folder":{"description":"ID of the folder where the form is located","type":"integer","nullable":true},"db":{"description":"Whether submissions are saved to the database","type":"boolean","nullable":false},"deleted":{"description":"Whether the form is deleted","type":"boolean","nullable":false},"numberOfColumns":{"description":"Number of visible columns in the form","type":"string","nullable":false},"progressMeter":{"description":"Whether progress meter is enabled","type":"string","nullable":false},"submissions":{"description":"Number of submissions","type":"string","nullable":false},"submissionsUnread":{"description":"Number of unread submissions","type":"string","nullable":false},"views":{"description":"Number of form views","type":"string","nullable":false},"version":{"description":"Form version","type":"string","nullable":false},"language":{"description":"Form language","type":"string","nullable":false},"encrypted":{"description":"Whether the form is encrypted","type":"boolean","nullable":false},"thumbnailUrl":{"description":"URL to form thumbnail","type":"string","nullable":true},"submitButtonTitle":{"description":"Title of the submit button","type":"string","nullable":false},"inactive":{"description":"Whether the form is inactive","type":"boolean","nullable":false},"timezone":{"description":"Form timezone","type":"string","nullable":false},"shouldDisplayOneQuestionAtATime":{"description":"Whether the form should display one question at a time","type":"boolean","nullable":false},"isWorkflowForm":{"description":"Whether the form is a workflow form","type":"boolean","nullable":false},"isWorkflowPublished":{"description":"Whether the workflow form is published","type":"boolean","nullable":false},"editUrl":{"description":"URL to edit form","type":"string","nullable":false},"dataUrl":{"description":"URL to form data","type":"string","nullable":false},"summaryUrl":{"description":"URL to form summary","type":"string","nullable":false}},"type":"object"},"FormsListingApiDto":{"title":"Forms Listing","description":"Forms listing response","properties":{"page":{"$ref":"#/components/schemas/PaginationApiDto"},"forms":{"description":"Array of form previews","type":"array","items":{"$ref":"#/components/schemas/FormPreviewApiDto"},"nullable":true}},"type":"object"},"PrefillResponseApiDto":{"title":"Prefill Response","description":"Prefill response","properties":{"prefilledUrl":{"description":"Url for prefilled form","type":"string","nullable":false}},"type":"object"},"CopyFormOptionsApiDto":{"title":"Copy Form Options","description":"Copy form options","properties":{"includeIntegrations":{"description":"Flag to specify whether to copy integrations","type":"boolean","default":true,"nullable":true},"includeEmails":{"description":"Flag to specify whether to copy emails","type":"boolean","default":true,"nullable":true},"folder":{"description":"Id of folder where copy should be saved","type":"integer","nullable":true},"template":{"description":"Id of template to use when copying","type":"integer","nullable":true}},"type":"object"},"CreateFormInputApiDto":{"title":"Create Form","description":"Create Form request","properties":{"name":{"description":"Name of the form","type":"string","nullable":false},"template":{"description":"ID of template of the form","type":"integer","nullable":true},"stockTemplate":{"description":"Stock theme template code for the form","type":"string","default":"light","enum":["berryNice","blueAfterglow","calmZigZag","celadonParchment","clean","confetti","corporateOffice","dark","duskPop","formstack","geometric","light","midnight","minimalism","oceanTide","peachyKeen","simple"],"nullable":true},"folder":{"description":"ID of the folder where the form will be created","type":"integer","nullable":true},"submitButtonTitle":{"description":"Title of submit button on live form","type":"string","default":"Submit Form","nullable":true},"numberOfColumns":{"description":"Number of visible columns in the form","type":"integer","default":1,"nullable":true},"fieldLabelsPosition":{"description":"Position where field labels are placed on the live form","type":"string","default":"top","enum":["top","left"],"nullable":false},"saveSubmissionsToDatabase":{"description":"Flag to disable or enable submissions to be saved in our database","type":"boolean","default":true,"nullable":false},"timezone":{"description":"Timezone of the form","type":"string","default":"US/Eastern","enum":["Pacific/Kwajalein","Pacific/Midway","Pacific/Honolulu","America/Anchorage","US/Pacific","US/Arizona","US/Mountain","US/Central","America/Mexico_City","Canada/Saskatchewan","America/Lima","US/Eastern","US/East-Indiana","Canada/Atlantic","America/Caracas","America/St_Johns","America/Buenos_Aires","Atlantic/South_Georgia","Atlantic/Azores","Europe/London","Africa/Monrovia","Europe/Berlin","Europe/Brussels","Europe/Lisbon","Europe/Paris","Europe/Prague","Europe/Athens","Europe/Bucharest","Africa/Cairo","Africa/Harare","Asia/Jerusalem","Asia/Baghdad","Europe/Moscow","Asia/Tehran","Asia/Muscat","Asia/Kabul","Asia/Karachi","Asia/Calcutta","Asia/Almaty","Asia/Bangkok","Asia/Urumqi","Asia/Hong_Kong","Asia/Tokyo","Australia/Adelaide","Australia/Darwin","Australia/Brisbane","Australia/Melbourne","Pacific/Guam","Australia/Hobart","Asia/Magadan","Pacific/Fiji","Pacific/Auckland"],"nullable":true},"language":{"description":"Language of the form","type":"string","default":"en","enum":["af","sq","ar","bg","zh","zh-TW","hr","cs","da","nl","en","fi","fr","de","el","he","hu","is","id","it","ja","kk","ko","no","pl","pt","ro","ru","es","sk","sl","sv","th","tr","vi","cy"],"nullable":true},"isActive":{"description":"Flag to make the form active/inactive","type":"boolean","default":true,"nullable":false},"disabledMessage":{"description":"The message to show when the form is inactive","type":"string","nullable":true},"fields":{"description":"Optional fields to create with the form","type":"array","items":{"$ref":"#/components/schemas/CreateFieldInputApiDto"},"nullable":true}},"type":"object"},"CreateFormPrefillApiDto":{"title":"Create Form Prefill","description":"Create form prefill","properties":{"incompletePassword":{"description":"Password for prefill","type":"string","nullable":true},"workflowStepKey":{"description":"Internal use only. Used by Workflows (Copilot) to link form submissions back to workflow steps. Not applicable for standard API usage.","type":"string","nullable":true},"fields":{"description":"Array of field data to prefill with their values","type":"array","items":{"$ref":"#/components/schemas/PrefillParsedFieldApiDto"},"nullable":false}},"type":"object"},"EditFormInputApiDto":{"title":"Edit Form","description":"Edit Form request","properties":{"name":{"description":"Name of the form","type":"string","nullable":false},"template":{"description":"ID of template of the form","type":"integer","nullable":true},"stockTemplate":{"description":"Stock theme template code for the form","type":"string","default":"light","enum":["berryNice","blueAfterglow","calmZigZag","celadonParchment","clean","confetti","corporateOffice","dark","duskPop","formstack","geometric","light","midnight","minimalism","oceanTide","peachyKeen","simple"],"nullable":true},"folder":{"description":"ID of the folder where the form will be moved","type":"integer","nullable":true},"submitButtonTitle":{"description":"Title of submit button on live form","type":"string","nullable":true},"numberOfColumns":{"description":"Number of visible columns in the form","type":"integer","nullable":true},"fieldLabelsPosition":{"description":"Position where field labels are placed on the live form","type":"string","enum":["top","left"],"nullable":false},"saveSubmissionsToDatabase":{"description":"Flag to disable or enable submissions to be saved in our database","type":"boolean","nullable":false},"timezone":{"description":"Timezone of the form","type":"string","enum":["Pacific/Kwajalein","Pacific/Midway","Pacific/Honolulu","America/Anchorage","US/Pacific","US/Arizona","US/Mountain","US/Central","America/Mexico_City","Canada/Saskatchewan","America/Lima","US/Eastern","US/East-Indiana","Canada/Atlantic","America/Caracas","America/St_Johns","America/Buenos_Aires","Atlantic/South_Georgia","Atlantic/Azores","Europe/London","Africa/Monrovia","Europe/Berlin","Europe/Brussels","Europe/Lisbon","Europe/Paris","Europe/Prague","Europe/Athens","Europe/Bucharest","Africa/Cairo","Africa/Harare","Asia/Jerusalem","Asia/Baghdad","Europe/Moscow","Asia/Tehran","Asia/Muscat","Asia/Kabul","Asia/Karachi","Asia/Calcutta","Asia/Almaty","Asia/Bangkok","Asia/Urumqi","Asia/Hong_Kong","Asia/Tokyo","Australia/Adelaide","Australia/Darwin","Australia/Brisbane","Australia/Melbourne","Pacific/Guam","Australia/Hobart","Asia/Magadan","Pacific/Fiji","Pacific/Auckland"],"nullable":true},"language":{"description":"Language of the form","type":"string","enum":["af","sq","ar","bg","zh","zh-TW","hr","cs","da","nl","en","fi","fr","de","el","he","hu","is","id","it","ja","kk","ko","no","pl","pt","ro","ru","es","sk","sl","sv","th","tr","vi","cy"],"nullable":true},"isActive":{"description":"Flag to make the form active/inactive","type":"boolean","nullable":false},"disabledMessage":{"description":"The message to show when the form is inactive","type":"string","nullable":true}},"type":"object"},"GetFormDetailsApiDto":{"title":"Get Form Details","description":"Get Form Details request parameters","properties":{"withFields":{"description":"Include form fields in response","type":"boolean","default":false,"nullable":true}},"type":"object"},"GetFormsListApiDto":{"title":"Get Forms List","description":"Get forms list params","properties":{"pageNumber":{"description":"Page to use when paginating through items.","type":"integer","minimum":1,"nullable":true},"pageSize":{"description":"Number of items to return per page.","type":"integer","default":50,"maximum":500,"minimum":10,"nullable":true},"search":{"description":"Search by form name","type":"string","nullable":true},"orderBy":{"description":"Column to order results.","type":"string","nullable":true},"order":{"description":"Order direction of results.","type":"string","default":"ASC","enum":["ASC","DESC"],"nullable":true},"folder":{"description":"Forms from specified folder.","type":"integer","nullable":true}},"type":"object"},"PrefillParsedFieldAddressValueApiDto":{"title":"Prefill Parsed Field Address Value","description":"Prefill parsed field address value","properties":{"address":{"description":"First part of the address","type":"string","nullable":true},"address2":{"description":"Second part of the address","type":"string","nullable":true},"city":{"description":"City of the address","type":"string","nullable":true},"country":{"description":"Country of the address","type":"string","nullable":true},"state":{"description":"State of the address","type":"string","nullable":true},"zip":{"description":"Zip of the address","type":"string","nullable":true}},"type":"object"},"PrefillParsedFieldCheckboxValueApiDto":{"title":"Prefill Parsed Field Checkbox Value","description":"Prefill parsed field checkbox value","allOf":[{"$ref":"#/components/schemas/PrefillParsedFieldSubValuesApiDto"}]},"PrefillParsedFieldDatetimeValueApiDto":{"title":"Prefill Parsed Field Datetime Value","description":"Prefill parsed field datetime value","type":"object","allOf":[{"$ref":"#/components/schemas/PrefillParsedFieldSingleValueApiDto"},{"properties":{"value":{"description":"Value of the datetime field","type":"string","nullable":true}},"type":"object"}]},"PrefillParsedFieldEmailValueApiDto":{"title":"Prefill Parsed Field Email Value","description":"Prefill parsed field email value","type":"object","allOf":[{"$ref":"#/components/schemas/PrefillParsedFieldSingleValueApiDto"},{"properties":{"value":{"description":"Value of the email field","type":"string","nullable":true}},"type":"object"}]},"PrefillParsedFieldMatrixValueApiDto":{"title":"Prefill Parsed Field Matrix Value","description":"Prefill parsed field matrix value","allOf":[{"$ref":"#/components/schemas/PrefillParsedFieldSubValuesApiDto"}]},"PrefillParsedFieldNameValueApiDto":{"title":"Prefill Parsed Field Name Value","description":"Prefill parsed field name value","properties":{"prefix":{"description":"Prefix of the name","type":"string","nullable":true},"first":{"description":"First name of the name","type":"string","nullable":true},"initial":{"description":"Initial of the name","type":"string","nullable":true},"middle":{"description":"Middle of the name","type":"string","nullable":true},"last":{"description":"Last name of the name","type":"string","nullable":true},"suffix":{"description":"Suffix of the name","type":"string","nullable":true}},"type":"object"},"PrefillParsedFieldNumberValueApiDto":{"title":"Prefill Parsed Field Number Value","description":"Prefill parsed field number value","type":"object","allOf":[{"$ref":"#/components/schemas/PrefillParsedFieldSingleValueApiDto"},{"properties":{"value":{"description":"Value of the number field","type":"string","nullable":true}},"type":"object"}]},"PrefillParsedFieldPhoneValueApiDto":{"title":"Prefill Parsed Field Phone Value","description":"Prefill parsed field phone value","allOf":[{"$ref":"#/components/schemas/PrefillParsedFieldSingleValueApiDto"}]},"PrefillParsedFieldProductValueApiDto":{"title":"Prefill Parsed Field Product Value","description":"Prefill parsed field product value","properties":{"chargeType":{"description":"ChargeType of the product","type":"string","nullable":false},"quantity":{"description":"Quantity of the product","type":"string","nullable":true},"total":{"description":"Total of the product","type":"string","nullable":true},"unitPrice":{"description":"UnitPrice of the product","type":"string","nullable":true}},"type":"object"},"PrefillParsedFieldRadioValueApiDto":{"title":"Prefill Parsed Field Radio Value","description":"Prefill parsed field radio value","allOf":[{"$ref":"#/components/schemas/PrefillParsedFieldSingleValueApiDto"}]},"PrefillParsedFieldRatingValueApiDto":{"title":"Prefill Parsed Field Rating Value","description":"Prefill parsed field rating value","allOf":[{"$ref":"#/components/schemas/PrefillParsedFieldSingleValueApiDto"}]},"PrefillParsedFieldSelectValueApiDto":{"title":"Prefill Parsed Field Select Value","description":"Prefill parsed field select value","allOf":[{"$ref":"#/components/schemas/PrefillParsedFieldSingleValueApiDto"}]},"PrefillParsedFieldSingleValueApiDto":{"title":"Prefill Parsed Field Single Value","description":"Prefill parsed field single value","properties":{"value":{"description":"Value of the prefill field","type":"string","nullable":true}},"type":"object"},"PrefillParsedFieldSubValueApiDto":{"title":"Prefill Parsed Field SubValue","description":"Prefill parsed field subvalue","properties":{"subvalue":{"description":"Subvalue of the prefill field","type":"string","nullable":true}},"type":"object"},"PrefillParsedFieldSubValuesApiDto":{"title":"Prefill Parsed Field SubValues","description":"Prefill parsed field subvalues","properties":{"subvalues":{"description":"Subvalues of the prefill field","type":"array","items":{"$ref":"#/components/schemas/PrefillParsedFieldSubValueApiDto"},"nullable":true}},"type":"object"},"PrefillParsedFieldTableCellValueApiDto":{"title":"Prefill Parsed Field Table Cell Value","description":"Prefill parsed field table cell value","type":"object","allOf":[{"$ref":"#/components/schemas/PrefillParsedFieldSingleValueApiDto"},{"properties":{"value":{"description":"Value of the table cell field","type":"string","nullable":true}},"type":"object"}]},"PrefillParsedFieldTextValueApiDto":{"title":"Prefill Parsed Field Text Value","description":"Prefill parsed field text value","allOf":[{"$ref":"#/components/schemas/PrefillParsedFieldSingleValueApiDto"}]},"PrefillParsedFieldTextareaValueApiDto":{"title":"Prefill Parsed Field Textarea Value","description":"Prefill parsed field textarea value","allOf":[{"$ref":"#/components/schemas/PrefillParsedFieldSingleValueApiDto"}]},"PrefillParsedFieldApiDto":{"title":"Prefill Parsed Field","description":"Prefill parsed field","properties":{"id":{"description":"Id of the prefill field","type":"string","nullable":false},"value":{"description":"Value of the prefill field","nullable":true,"oneOf":[{"$ref":"#/components/schemas/PrefillParsedFieldTextValueApiDto"},{"$ref":"#/components/schemas/PrefillParsedFieldNameValueApiDto"},{"$ref":"#/components/schemas/PrefillParsedFieldAddressValueApiDto"},{"$ref":"#/components/schemas/PrefillParsedFieldProductValueApiDto"},{"$ref":"#/components/schemas/PrefillParsedFieldTableCellValueApiDto"},{"$ref":"#/components/schemas/PrefillParsedFieldDatetimeValueApiDto"},{"$ref":"#/components/schemas/PrefillParsedFieldRatingValueApiDto"},{"$ref":"#/components/schemas/PrefillParsedFieldRadioValueApiDto"},{"$ref":"#/components/schemas/PrefillParsedFieldNumberValueApiDto"},{"$ref":"#/components/schemas/PrefillParsedFieldPhoneValueApiDto"},{"$ref":"#/components/schemas/PrefillParsedFieldEmailValueApiDto"},{"$ref":"#/components/schemas/PrefillParsedFieldTextareaValueApiDto"},{"$ref":"#/components/schemas/PrefillParsedFieldMatrixValueApiDto"},{"$ref":"#/components/schemas/PrefillParsedFieldCheckboxValueApiDto"},{"$ref":"#/components/schemas/PrefillParsedFieldSelectValueApiDto"}]}},"type":"object"},"FormstackDocumentIntegrationDetailedApiDto":{"title":"Integration Details","description":"Form integration details response","properties":{"id":{"description":"The ID of the integration","type":"integer","nullable":false},"form":{"description":"ID of the form this integration is associated with","type":"integer","nullable":false},"type":{"description":"Type of integration","type":"string","nullable":false},"active":{"description":"Whether the integration is active","type":"boolean","nullable":false},"name":{"description":"Name of the integration","type":"string","nullable":false},"hasCredentials":{"description":"Whether the integration has valid credentials","type":"boolean","nullable":false}},"type":"object"},"CreateFormIntegrationInputApiDto":{"title":"Create Form Integration","description":"Create form WebMerge integration request","properties":{"type":{"description":"Type of WebMerge integration (document or route)","type":"string","enum":["document","route"],"nullable":false},"integrationId":{"description":"The ID of the document or route in WebMerge","type":"string","nullable":false},"webmergeToken":{"description":"JWT token for WebMerge authentication","type":"string","nullable":false}},"type":"object"},"PartialSubmissionDataAddressValueApiDto":{"title":"Partial Submission Data Address Value","description":"Partial submission data address value response","properties":{"address":{"description":"First part of the address","type":"string","nullable":true},"address2":{"description":"Second part of the address","type":"string","nullable":true},"city":{"description":"City of the address","type":"string","nullable":true},"country":{"description":"Country of the address","type":"string","nullable":true},"state":{"description":"State of the address","type":"string","nullable":true},"zip":{"description":"Zip of the address","type":"string","nullable":true}},"type":"object"},"PartialSubmissionDataCheckboxValueApiDto":{"title":"Partial Submission Data Checkbox Value","description":"Partial submission data checkbox value response","properties":{"values":{"description":"Values of the checkbox","type":"array","items":{"type":"string"},"nullable":true}},"type":"object"},"PartialSubmissionDataDatetimeValueApiDto":{"title":"Partial Submission Data Datetime Value","description":"Partial submission data datetime value response","properties":{"values":{"description":"Values of the datetime","type":"array","items":{"type":"string"},"nullable":true}},"type":"object"},"PartialSubmissionDataMatrixValueApiDto":{"title":"Partial Submission Data Matrix Value","description":"Partial submission data matrix value response","properties":{"values":{"description":"Values of the matrix","type":"array","items":{"type":"string"},"nullable":false}},"type":"object"},"PartialSubmissionDataNameValueApiDto":{"title":"Partial Submission Data Name Value","description":"Partial submission data name value response","properties":{"prefix":{"description":"Prefix of the name","type":"string","nullable":true},"first":{"description":"First name of the name","type":"string","nullable":true},"initial":{"description":"Initial of the name","type":"string","nullable":true},"middle":{"description":"Middle of the name","type":"string","nullable":true},"last":{"description":"Last name of the name","type":"string","nullable":true},"suffix":{"description":"Suffix of the name","type":"string","nullable":true}},"type":"object"},"PartialSubmissionDataProductValueApiDto":{"title":"Partial Submission Data Product Value","description":"Partial submission data product value response","properties":{"chargeType":{"description":"ChargeType of the product","type":"string","nullable":true},"quantity":{"description":"Quantity of the product","type":"string","nullable":true},"total":{"description":"Total of the product","type":"string","nullable":true},"unitPrice":{"description":"UnitPrice of the product","type":"string","nullable":true}},"type":"object"},"PartialSubmissionDataRadioValueApiDto":{"title":"Partial Submission Data Radio Value","description":"Partial submission data radio value response","properties":{"values":{"description":"Values of the radio","type":"array","items":{"type":"string"},"nullable":true}},"type":"object"},"PartialSubmissionDataSelectValueApiDto":{"title":"Partial Submission Data Select Value","description":"Partial submission data select value response","properties":{"values":{"description":"Values of the select","type":"array","items":{"type":"string"},"nullable":true}},"type":"object"},"PartialSubmissionDataApiDto":{"title":"Partial Submission Data","description":"Partial submission data response","properties":{"field":{"description":"Field of the partial submission","type":"string","nullable":false},"displayValue":{"description":"Display value of the related field in the partial submission","type":"string","nullable":true},"parsedValue":{"description":"Parsed value of the related field in the partial submission","nullable":true,"oneOf":[{"$ref":"#/components/schemas/PartialSubmissionDataNameValueApiDto"},{"$ref":"#/components/schemas/PartialSubmissionDataAddressValueApiDto"},{"$ref":"#/components/schemas/PartialSubmissionDataDatetimeValueApiDto"},{"$ref":"#/components/schemas/PartialSubmissionDataProductValueApiDto"},{"$ref":"#/components/schemas/PartialSubmissionDataCheckboxValueApiDto"},{"$ref":"#/components/schemas/PartialSubmissionDataRadioValueApiDto"},{"$ref":"#/components/schemas/PartialSubmissionDataMatrixValueApiDto"},{"$ref":"#/components/schemas/PartialSubmissionDataSelectValueApiDto"}]}},"type":"object"},"PartialSubmissionDetailedApiDto":{"title":"PartialSubmission Detailed","description":"Partial submission detailed response","properties":{"id":{"description":"ID of the partial submission","type":"integer","nullable":false},"timestamp":{"description":"Timestamp of the partial submission","type":"string","nullable":true},"userAgent":{"description":"User agent of the partial submission","type":"string","nullable":true},"remoteAddr":{"description":"Remote address of the partial submission","type":"string","nullable":true},"formId":{"description":"ID of the partial submission form","type":"integer","nullable":true},"latitude":{"description":"Latitude of the partial submission","type":"string","nullable":true},"longitude":{"description":"Longitude of the partial submission","type":"string","nullable":true},"prettyFieldId":{"description":"ID of the partial submission pretty field","type":"integer","nullable":true},"prettyName":{"description":"Pretty name of the partial submission","type":"string","nullable":true},"data":{"description":"Data of the partial submission","type":"array","items":{"$ref":"#/components/schemas/PartialSubmissionDataApiDto"},"nullable":true}},"type":"object"},"PartialSubmissionIdApiDto":{"title":"PartialSubmission Id","description":"Partial submission ID response","properties":{"id":{"description":"ID of the partial submission","type":"integer","nullable":false}},"type":"object"},"PartialSubmissionPreviewApiDto":{"title":"Partial Submission Preview","description":"Partial submission preview response","properties":{"id":{"description":"The ID of the partial submission","type":"integer","nullable":false},"formId":{"description":"The ID of the partial submission form","type":"integer","nullable":false},"timestamp":{"description":"Timestamp of the partial submission","type":"string","nullable":false},"data":{"description":"Data of the partial submission (equals null also if this field isn't requested)","type":"array","items":{"$ref":"#/components/schemas/PartialSubmissionPreviewDataApiDto"},"nullable":true},"prettyName":{"description":"Pretty name of the partial submission (equals null also if this field isn't requested)","type":"string","nullable":true}},"type":"object"},"PartialSubmissionPreviewDataApiDto":{"title":"Partial Submission Preview Data","description":"Partial submission preview data response"},"PartialSubmissionsListingApiDto":{"title":"Partial Submissions Listing","description":"Partial submissions listing response","properties":{"page":{"$ref":"#/components/schemas/PaginationApiDto"},"partialSubmissions":{"description":"Preview of partial submission in list","type":"array","items":{"$ref":"#/components/schemas/PartialSubmissionPreviewApiDto"},"nullable":true}},"type":"object"},"GetPartialSubmissionsListApiDto":{"title":"Get Partial Submissions List","description":"Get partial submissions list params","properties":{"pageNumber":{"description":"Page to use when paginating through items.","type":"integer","minimum":1,"nullable":true},"pageSize":{"description":"Number of items to return per page.","type":"integer","default":50,"maximum":500,"minimum":10,"nullable":true},"order":{"description":"Order direction of results.","type":"string","default":"ASC","enum":["ASC","DESC"],"nullable":true},"keyword":{"description":"Keyword to search.","type":"string","nullable":true},"minTime":{"description":"Return partial submissions created at and after the given date/time. Format: YYYY-MM-DD or YYYY-MM-DD HH:MM:SS (Eastern Time).","type":"string","nullable":true},"maxTime":{"description":"Return partial submissions created at and before the given date/time. Format: YYYY-MM-DD or YYYY-MM-DD HH:MM:SS (Eastern Time).","type":"string","nullable":true},"search":{"description":"Array of search criteria to filter partial submissions by specific field values. Each criterion must include a fieldId and value. Maximum 10 search criteria allowed (index 0-9).","type":"array","items":{"$ref":"#/components/schemas/SearchCriterionDto"},"example":[{"fieldId":"123456","value":"john@example.com"},{"fieldId":"789012","value":"New York"}],"nullable":true},"data":{"description":"Set to 'true' to include partial submission data in the response.","type":"string","nullable":true},"expandData":{"description":"Set to 'true' to expand partial submission data with detailed field information.","type":"string","nullable":true},"prettyName":{"description":"Set to 'true' to include pretty names for partial submissions.","type":"string","nullable":true}},"type":"object"},"PortalAndFormIdApiDto":{"title":"Portal And Form Id","description":"Response containing portal and form identifiers","properties":{"portalId":{"description":"Unique identifier of the portal","type":"integer","nullable":false},"formId":{"description":"Unique identifier of the form","type":"integer","nullable":false}},"type":"object"},"PortalAndUserIdApiDto":{"title":"Portal And User ID","description":"Response containing portal and user identifiers","properties":{"portalId":{"description":"Unique identifier of the portal","type":"integer","nullable":false},"userId":{"description":"Unique identifier of the user","type":"integer","nullable":false}},"type":"object"},"PortalDetailedApiDto":{"title":"Portal Detailed","description":"Portal detailed response","properties":{"id":{"description":"Unique identifier of the portal","type":"integer","nullable":false},"name":{"description":"Name of the portal","type":"string","nullable":false},"description":{"description":"Description of the portal","type":"string","nullable":true},"avatar":{"description":"Avatar image URL for the portal","type":"string","nullable":true},"created":{"description":"Creation timestamp of the portal (Y-m-d H:i:s format)","type":"string","nullable":true},"timezone":{"description":"Timezone of the portal","type":"string","nullable":true},"participantCount":{"description":"Number of participants in the portal","type":"integer","nullable":true},"forms":{"description":"List of forms associated with the portal","type":"array","items":{"$ref":"#/components/schemas/PortalFormApiDto"},"nullable":true},"users":{"description":"List of users associated with the portal","type":"array","items":{"$ref":"#/components/schemas/PortalUserApiDto"},"nullable":true}},"type":"object"},"PortalDetailsDeadlineApiDto":{"title":"Portal details deadline","description":"Portal details deadline response","properties":{"frequency":{"description":"How often the deadline recurs (daily, weekly, monthly)","type":"string","nullable":true},"dueTime":{"description":"Time when the deadline is due","type":"string","nullable":true},"earlyReminderHours":{"description":"Number of hours before deadline to send early reminder","type":"integer","nullable":true},"dueDay":{"description":"Day when the deadline is due (for weekly/monthly frequencies)","type":"string","nullable":true},"earlyReminderDays":{"description":"Number of days before deadline to send early reminder","type":"integer","nullable":true},"dueDate":{"description":"Due date of the portal deadline","type":"string","nullable":true}},"type":"object"},"PortalFormApiDto":{"title":"Portal Form","description":"Portal form response","properties":{"id":{"description":"Unique identifier of the portal form","type":"integer","nullable":false},"name":{"description":"Name of the portal form","type":"string","nullable":true},"completedUserCount":{"description":"Number of users who have completed the portal form","type":"integer","nullable":true},"description":{"description":"Description of the portal form","type":"string","nullable":true},"formUrl":{"description":"URL of the portal form","type":"string","nullable":true},"formId":{"description":"Form ID of the portal form","type":"integer","nullable":true},"deadline":{"oneOf":[{"$ref":"#/components/schemas/PortalDetailsDeadlineApiDto"}],"nullable":true,"description":"Deadline configuration for the portal form"},"usersPerformance":{"description":"Performance data for users in the portal form","type":"array","items":{"$ref":"#/components/schemas/PortalUserPerformanceApiDto"},"nullable":true}},"type":"object"},"PortalIdApiDto":{"title":"Portal ID","description":"Response containing portal identifier","properties":{"portalId":{"description":"Unique identifier of the portal","type":"integer","nullable":false}},"type":"object"},"PortalUserApiDto":{"title":"Portal User","description":"Portal user response","properties":{"id":{"description":"Unique identifier of the portal user","type":"integer","nullable":false},"avatarUrl":{"description":"Avatar URL of the portal user","type":"string","nullable":false},"email":{"description":"Email address of the portal user","type":"string","nullable":false},"name":{"description":"Name of the portal user","type":"string","nullable":false},"type":{"description":"Type of the portal user (account or external)","type":"string","nullable":false}},"type":"object"},"PortalUserPerformanceApiDto":{"title":"Portal User Performance","description":"Portal user performance response","properties":{"id":{"description":"Unique identifier of the portal user","type":"integer","nullable":false},"lastSubmissionId":{"description":"ID of the user's most recent submission","type":"integer","nullable":true},"formCompletionDate":{"description":"Date when the user completed the form","type":"string","nullable":true}},"type":"object"},"PortalPreviewApiDto":{"title":"Portal Preview","description":"Portal preview information for listing","properties":{"id":{"description":"Unique identifier of the portal","type":"integer","nullable":false},"name":{"description":"Name of the portal","type":"string","nullable":false},"description":{"description":"Description of the portal","type":"string","nullable":true},"avatar":{"description":"Avatar image URL for the portal","type":"string","nullable":true},"created":{"description":"Creation timestamp of the portal","type":"string","nullable":true},"timezone":{"description":"Timezone of the portal","type":"string","nullable":true}},"type":"object"},"PortalsListingApiDto":{"title":"Portals Listing","description":"Portals listing response","properties":{"portals":{"description":"List of portal previews","type":"array","items":{"$ref":"#/components/schemas/PortalPreviewApiDto"},"nullable":true}},"type":"object"},"CreatePortalFormInputApiDto":{"title":"Create Portal Form","description":"Create Portal Form request","required":["formId","name"],"properties":{"formId":{"description":"Id of the form","type":"integer","nullable":false},"name":{"description":"Name of the form","type":"string","nullable":false},"description":{"description":"Description of the form","type":"string","nullable":false},"notifyUsers":{"description":"Flag to notify users","type":"string","nullable":true},"deadline":{"oneOf":[{"$ref":"#/components/schemas/PortalRequestDeadlineApiDto"}],"nullable":true,"description":"Deadline of the form"}},"type":"object"},"CreatePortalUserInputApiDto":{"title":"Create Portal User","description":"Create Portal User request","required":["emails"],"properties":{"emails":{"description":"Comma-separated emails of the portal users (e.g., first@email.com,second@email.com).","type":"string","nullable":false}},"type":"object"},"EditPortalFormInputApiDto":{"title":"Edit Portal Form","description":"Edit Portal Form request","required":["name","formId"],"properties":{"name":{"description":"Name of the portal form","type":"string","nullable":false},"formId":{"description":"FormId of the portal form","type":"string","nullable":false},"description":{"description":"Description of the portal form","type":"string","nullable":true},"notifyUsers":{"description":"Flag to notify users","type":"string","nullable":true},"deadline":{"oneOf":[{"$ref":"#/components/schemas/PortalRequestDeadlineApiDto"}],"nullable":true,"description":"Deadline of the form"}},"type":"object"},"EditPortalInputApiDto":{"title":"Edit Portal","description":"Edit Portal request","required":["name"],"properties":{"name":{"description":"Name of the portal","type":"string","nullable":false},"description":{"description":"Description of the portal","type":"string","nullable":true}},"type":"object"},"EditPortalUserInputApiDto":{"title":"Edit Portal User","description":"Edit Portal User request","required":["name"],"properties":{"name":{"description":"Name of the portal user","type":"string","nullable":false}},"type":"object"},"PortalRequestDeadlineApiDto":{"title":"Portal Request Deadline","description":"Portal Deadline request","properties":{"frequency":{"description":"Frequency of the portal deadline","type":"string","nullable":true},"dueTime":{"description":"Due time of the portal deadline","type":"string","nullable":true},"earlyReminderHours":{"description":"Early reminder hours of the portal deadline","type":"integer","nullable":true},"dueDay":{"description":"Due day of the portal deadline","type":"string","nullable":true},"earlyReminderDays":{"description":"Early reminder days of the portal deadline","type":"integer","nullable":true},"dueDate":{"description":"Due date of the portal deadline","type":"string","nullable":true}},"type":"object"},"DatetimeCalculationDto":{"title":"Datetime Calculation","description":"Datetime calculation definition for fields","properties":{"fieldOneCalculation":{"description":"First field used for date calculation (or current_date)","type":"string","nullable":false},"fieldTwoCalculation":{"description":"Second field used for date calculation (or current_date)","type":"string","nullable":true},"calculationUnits":{"description":"Units used for date calculation (days, months, years)","type":"string","enum":["days","months","years"],"nullable":true},"calculationOperator":{"description":"Operator used for date calculation (+, -)","type":"string","enum":["+","-"],"nullable":true},"calculationType":{"description":"Type of date calculation","type":"string","enum":["date"],"nullable":true},"calculationAllowNegatives":{"description":"Decide if date calculation allows negative values","type":"boolean","default":false,"nullable":true}},"type":"object"},"NumericCalculationDto":{"title":"Numeric Calculation","description":"Numeric calculation definition for fields","properties":{"formula":{"description":"Formula for numeric calculation","type":"string","nullable":false}},"type":"object"},"IdApiDto":{"title":"Id Response","description":"Generic ID response","properties":{"id":{"description":"The ID of the resource","type":"integer","nullable":false}},"type":"object"},"LogicDto":{"title":"Logic Conditions","description":"Logic conditions for conditional processing","properties":{"action":{"description":"Action to perform (show/hide)","type":"string","enum":["show","hide"],"nullable":false},"conditional":{"description":"Conditional operator (all/any)","type":"string","enum":["all","any"],"nullable":false},"checks":{"description":"Array of condition checks","type":"array","items":{"$ref":"#/components/schemas/LogicFieldCheckDto"},"nullable":false}},"type":"object"},"LogicFieldCheckDto":{"title":"Logic Check Condition","description":"Single condition check for logic operations","properties":{"field":{"description":"Field ID to check","type":"string","nullable":false},"condition":{"description":"Condition operator","type":"string","enum":["equals","notequals","greaterthan","lessthan"],"nullable":false},"option":{"description":"Value to compare against","type":"string","nullable":false}},"type":"object"},"PaginationApiDto":{"title":"Pagination Info","description":"Pagination information","properties":{"size":{"description":"The amount of records returned for this page","type":"integer","nullable":false},"pageNumber":{"description":"The current page number","type":"integer","nullable":false},"pageSize":{"description":"The actual page size","type":"integer","nullable":false},"totalElements":{"description":"The total amount of resources available","type":"integer","nullable":false},"totalPages":{"description":"The total amount of pages available, based on the pageSize","type":"integer","nullable":false}},"type":"object"},"ResourceIdDto":{"title":"Resource Identifier","description":"Contains the identifier of a resource after an operation","properties":{"id":{"description":"The identifier of the resource","type":"integer","format":"int64","example":1}},"type":"object"},"SearchCriterionDto":{"title":"Search Criterion","description":"A single search criterion for filtering by field value","properties":{"fieldId":{"description":"The ID of the field to search","type":"string","example":"123456"},"value":{"description":"The value to search for in the field","type":"string","example":"john@example.com"}},"type":"object"},"SmartListDetailedApiDto":{"title":"Smart List Details","description":"Smart List details response","properties":{"id":{"description":"The ID of the smart list","type":"integer","nullable":false},"name":{"description":"Name of the smart list","type":"string","nullable":false},"useImages":{"description":"Whether the smart list uses images","type":"boolean","nullable":false},"useSeparateValues":{"description":"Whether the smart list uses separate values","type":"boolean","nullable":false},"created":{"description":"Date when the smart list was created (ISO 8601 format)","type":"string","format":"date-time","example":"2023-12-01T10:30:00Z","nullable":false},"updated":{"description":"Date when the smart list was last updated (ISO 8601 format)","type":"string","format":"date-time","example":"2023-12-01T15:45:00Z","nullable":false}},"type":"object"},"SmartListOptionDetailedApiDto":{"title":"Smart List Option Details","description":"Smart List option details response","properties":{"id":{"description":"The ID of the smart list option","type":"integer","nullable":false},"label":{"description":"Display label of the smart list option","type":"string","nullable":false},"value":{"description":"Value of the smart list option (used when separate values are enabled)","type":"string","nullable":false},"imageUrl":{"description":"URL of the option image if available","type":"string","nullable":true},"sort":{"description":"Sort order of the option","type":"integer","nullable":false},"created":{"description":"Date when the option was created (ISO 8601 format)","type":"string","format":"date-time","example":"2023-12-01T10:30:00Z","nullable":false},"updated":{"description":"Date when the option was last updated (ISO 8601 format)","type":"string","format":"date-time","example":"2023-12-01T15:45:00Z","nullable":false}},"type":"object"},"SmartListOptionsListingApiDto":{"title":"SmartList Options Listing","description":"SmartList options listing response","properties":{"page":{"$ref":"#/components/schemas/PaginationApiDto"},"options":{"description":"List of smart list options","type":"array","items":{"$ref":"#/components/schemas/SmartListOptionDetailedApiDto"},"nullable":false}},"type":"object"},"SmartListPreviewApiDto":{"title":"Smart List Preview","description":"Smart List preview response for listings","properties":{"id":{"description":"The ID of the smart list","type":"integer","nullable":false},"name":{"description":"Name of the smart list","type":"string","nullable":false},"useImages":{"description":"Whether the smart list uses images","type":"boolean","nullable":false},"useSeparateValues":{"description":"Whether the smart list uses separate values","type":"boolean","nullable":false},"created":{"description":"Date when the smart list was created (ISO 8601 format)","type":"string","format":"date-time","example":"2023-12-01T10:30:00Z","nullable":false},"updated":{"description":"Date when the smart list was last updated (ISO 8601 format)","type":"string","format":"date-time","example":"2023-12-01T15:45:00Z","nullable":false}},"type":"object"},"SmartListsListingApiDto":{"title":"Smart Lists Listing","description":"Smart Lists listing response","properties":{"page":{"$ref":"#/components/schemas/PaginationApiDto"},"smartLists":{"description":"List of smart lists","type":"array","items":{"$ref":"#/components/schemas/SmartListPreviewApiDto"},"nullable":false}},"type":"object"},"BulkSmartListOptionsInputApiDto":{"title":"Bulk Smart List Options","description":"Bulk Smart List Options request","required":["options"],"properties":{"options":{"description":"Array of options to create","type":"array","items":{"$ref":"#/components/schemas/CreateSmartListOptionInputApiDto"},"nullable":false}},"type":"object"},"CreateSmartListInputApiDto":{"title":"Create Smart List","description":"Create Smart List request","required":["name"],"properties":{"name":{"description":"Name of the smart list","type":"string","maxLength":255,"example":"My Smart List","nullable":false},"useImages":{"description":"Whether the smart list should use images for options","type":"boolean","default":false,"nullable":false},"useSeparateValues":{"description":"Whether the smart list should use separate values for options","type":"boolean","default":false,"nullable":false}},"type":"object"},"CreateSmartListOptionInputApiDto":{"title":"Create Smart List Option","description":"Create Smart List Option request","required":["label"],"properties":{"label":{"description":"Label/display text of the option","type":"string","example":"Option 1","nullable":false},"value":{"description":"Value of the option (if different from label)","type":"string","example":"option_1","nullable":true},"sort":{"description":"Sort order of the option","type":"integer","example":1,"nullable":true}},"type":"object"},"GetSmartListOptionsListApiDto":{"title":"Get SmartList Options List Input","description":"Input parameters for getting SmartList options list","properties":{"pageNumber":{"description":"Page to use when paginating through items.","type":"integer","minimum":1,"nullable":true},"pageSize":{"description":"Number of items to return per page.","type":"integer","default":50,"maximum":500,"minimum":10,"nullable":true},"query":{"description":"Search query to filter options by label","type":"string","nullable":true}},"type":"object"},"GetSmartListsListApiDto":{"title":"Get Smart Lists List Input","description":"Parameters for retrieving a paginated list of Smart Lists","properties":{"pageNumber":{"description":"Page to use when paginating through items.","type":"integer","minimum":1,"nullable":true},"pageSize":{"description":"Number of items to return per page.","type":"integer","default":50,"maximum":500,"minimum":10,"nullable":true},"query":{"description":"Optional search query to filter Smart Lists by name","type":"string","example":"marketing lists","nullable":true}},"type":"object"},"UpdateSmartListInputApiDto":{"title":"Update Smart List","description":"Update Smart List request","properties":{"name":{"description":"Name of the smart list","type":"string","maxLength":255,"example":"My Updated Smart List","nullable":true},"useImages":{"description":"Whether the smart list should use images for options","type":"boolean","nullable":true},"useSeparateValues":{"description":"Whether the smart list should use separate values for options","type":"boolean","nullable":true}},"type":"object"},"UpdateSmartListOptionInputApiDto":{"title":"Update Smart List Option","description":"Update Smart List Option request","properties":{"label":{"description":"Label/display text of the option","type":"string","example":"Updated Option 1","nullable":true},"value":{"description":"Value of the option (if different from label)","type":"string","example":"updated_option_1","nullable":true},"sort":{"description":"Sort order of the option","type":"integer","example":2,"nullable":true}},"type":"object"},"SubaccountFormDto":{"title":"Form Details","description":"Represents detailed form information","properties":{"id":{"description":"The ID of the form","type":"string","nullable":false},"name":{"description":"The name of the form","type":"string","nullable":false},"created":{"description":"Form creation date","type":"string","format":"date-time","nullable":true},"updated":{"description":"Form last update date","type":"string","format":"date-time","nullable":true},"active":{"description":"Whether the form is active","type":"boolean","nullable":false},"version":{"description":"Form version","type":"integer","nullable":true},"submissionCount":{"description":"Number of submissions for this form","type":"integer","nullable":true}},"type":"object"},"SmtpCredentialsApiDto":{"title":"SMTP Credentials","description":"SMTP credentials for a subaccount","properties":{"auth_method":{"description":"SMTP authentication method (e.g., plain, login, oauth)","type":"string","nullable":true},"host":{"description":"SMTP server hostname or IP address","type":"string","nullable":true},"port":{"description":"SMTP server port number","type":"integer","nullable":true},"username":{"description":"SMTP username","type":"string","nullable":true},"password":{"description":"SMTP password","type":"string","nullable":true},"oauth_token":{"description":"OAuth token for SMTP","type":"string","nullable":true},"oauth_refresh_token":{"description":"OAuth refresh token for SMTP","type":"string","nullable":true},"oauth_token_expires":{"description":"OAuth token expiration timestamp","type":"string","nullable":true}},"type":"object"},"SubaccountFormThemeAssignDto":{"title":"Form Theme Assignment Response","description":"Response after successfully assigning a theme to a form","properties":{"success":{"description":"Indicates if the theme assignment was successful","type":"boolean","nullable":false},"formId":{"description":"The ID of the form that received the theme","type":"string","nullable":false},"formName":{"description":"The name of the form that received the theme","type":"string","nullable":false},"currentThemeId":{"description":"The ID of the newly assigned theme","type":"string","nullable":false},"currentThemeName":{"description":"The name of the newly assigned theme","type":"string","nullable":false},"isCurrentThemeStock":{"description":"Indicates if the newly assigned theme is a stock theme","type":"boolean","nullable":false},"previousThemeId":{"description":"The ID of the theme that was previously assigned","type":"string","nullable":false},"previousThemeName":{"description":"The name of the theme that was previously assigned","type":"string","nullable":false},"isPreviousThemeStock":{"description":"Indicates if the previously assigned theme was a stock theme","type":"boolean","nullable":false}},"type":"object"},"SubaccountThemeFormListDto":{"title":"Theme Form List Response","description":"Paginated list of forms using a specific theme","properties":{"page":{"$ref":"#/components/schemas/PaginationApiDto"},"forms":{"description":"Array of form objects","type":"array","items":{"$ref":"#/components/schemas/SubaccountFormDto"}}},"type":"object"},"SubaccountThemeIdApiDto":{"title":"Theme ID Response","description":"Represents a theme ID in responses","properties":{"id":{"description":"The ID of the theme","type":"string","nullable":false}},"type":"object"},"SubaccountListItemApiDto":{"title":"Subaccount List Item","description":"Subaccount details for listing","properties":{"id":{"description":"The ID of the subaccount","type":"string","nullable":false},"url":{"description":"The base URL for accessing the subaccount","type":"string","nullable":true},"smtp_credentials":{"oneOf":[{"$ref":"#/components/schemas/SmtpCredentialsApiDto"}],"nullable":true,"description":"SMTP credentials for the subaccount"},"apikeys":{"description":"List of API access tokens associated with the subaccount","type":"array","items":{"properties":{"token":{"type":"string"}},"type":"object"},"nullable":true}},"type":"object"},"SubaccountsListingApiDto":{"title":"Subaccounts Listing","description":"List of subaccounts","properties":{"subaccounts":{"description":"Array of subaccount details","type":"array","items":{"$ref":"#/components/schemas/SubaccountListItemApiDto"},"nullable":false}},"type":"object"},"SubaccountAssignThemeToFormApiDto":{"title":"Assign Theme to Form Request","description":"Request data for assigning a theme to a form","properties":{"themeId":{"description":"The ID of the theme to assign to the form","type":"string","example":"light","nullable":false}},"type":"object"},"SubmissionDataAddressValueApiDto":{"title":"Submission Data Address Value","description":"Submission data address value response","properties":{"address":{"description":"First part of the address","type":"string","nullable":true},"address2":{"description":"Second part of the address","type":"string","nullable":true},"city":{"description":"City of the address","type":"string","nullable":true},"country":{"description":"Country of the address","type":"string","nullable":true},"state":{"description":"State of the address","type":"string","nullable":true},"zip":{"description":"Zip of the address","type":"string","nullable":true}},"type":"object"},"SubmissionDataCheckboxValueApiDto":{"title":"Submission Data Checkbox Value","description":"Submission data checkbox value response","properties":{"values":{"description":"Values of the checkbox","type":"array","items":{"type":"string"},"nullable":true}},"type":"object"},"SubmissionDataCreditCardValueApiDto":{"title":"Submission Data CreditCard Value","description":"Submission data credit card value response","properties":{"card":{"description":"Number of the credit card","type":"string","nullable":true},"cardexp":{"description":"Expiration date of the credit card","type":"string","nullable":true}},"type":"object"},"SubmissionDataDatetimeValueApiDto":{"title":"Submission Data Datetime Value","description":"Submission data datetime value response","properties":{"values":{"description":"Values of the datetime","type":"array","items":{"type":"string"},"nullable":true}},"type":"object"},"SubmissionDataFileValueApiDto":{"title":"Submission Data File Value","description":"Submission data file value response","properties":{"values":{"description":"Values of the file","type":"array","items":{"type":"string"},"nullable":true}},"type":"object"},"SubmissionDataMatrixValueApiDto":{"title":"Submission Data Matrix Value","description":"Submission data matrix value response","properties":{"values":{"description":"Values of the matrix","type":"array","items":{"type":"string"},"nullable":false}},"type":"object"},"SubmissionDataNameValueApiDto":{"title":"Submission Data Name Value","description":"Submission data name value response","properties":{"prefix":{"description":"Prefix of the name","type":"string","nullable":true},"first":{"description":"First name of the name","type":"string","nullable":true},"initial":{"description":"Initial of the name","type":"string","nullable":true},"middle":{"description":"Middle of the name","type":"string","nullable":true},"last":{"description":"Last name of the name","type":"string","nullable":true},"suffix":{"description":"Suffix of the name","type":"string","nullable":true}},"type":"object"},"SubmissionDataProductValueApiDto":{"title":"Submission Data Product Value","description":"Submission data product value response","properties":{"chargeType":{"description":"ChargeType of the product","type":"string","nullable":true},"quantity":{"description":"Quantity of the product","type":"string","nullable":true},"total":{"description":"Total of the product","type":"string","nullable":true},"unitPrice":{"description":"UnitPrice of the product","type":"string","nullable":true}},"type":"object"},"SubmissionDataRadioValueApiDto":{"title":"Submission Data Radio Value","description":"Submission data radio value response","properties":{"values":{"description":"Values of the radio","type":"array","items":{"type":"string"},"nullable":true}},"type":"object"},"SubmissionDataSelectValueApiDto":{"title":"Submission Data Select Value","description":"Submission data select value response","properties":{"values":{"description":"Values of the select","type":"array","items":{"type":"string"},"nullable":true}},"type":"object"},"SubmissionDataSignatureValueApiDto":{"title":"Submission Data Signature Value","description":"Submission data signature value response","properties":{"values":{"description":"Values of the signature","type":"array","items":{"type":"string"},"nullable":true}},"type":"object"},"FileUploadUrlApiDto":{"title":"File Upload URL","description":"A single presigned S3 upload target for a file field.","properties":{"filename":{"description":"The original filename supplied in the request. Use this to match each upload target to the file being uploaded.","type":"string"},"fileKey":{"description":"The S3 key to send back as the file field's `subvalue` when creating the submission.","type":"string"},"uploadUrl":{"description":"Presigned S3 PUT URL. Upload the raw file bytes here with an HTTP PUT. Expires 2 hours after generation.","type":"string","format":"uri"}},"type":"object"},"FileUploadUrlsApiDto":{"title":"File Upload URLs","description":"Presigned S3 upload targets for a file field. Upload each file to its `uploadUrl`, then submit the corresponding `fileKey` as the field's `subvalue` when creating the submission.","properties":{"fieldId":{"description":"The file field the upload targets were generated for.","type":"integer"},"fileUploads":{"description":"One upload target per requested filename.","type":"array","items":{"$ref":"#/components/schemas/FileUploadUrlApiDto"}}},"type":"object"},"FormSubmissionCountApiDto":{"title":"Form Submission Count","description":"Form submission count response","properties":{"totalSubmissions":{"description":"Total submissions","type":"integer","nullable":false},"totalSubmissionsByDay":{"description":"Total submissions by day","type":"array","items":{"$ref":"#/components/schemas/FormSubmissionCountByDayApiDto"},"nullable":false}},"type":"object"},"FormSubmissionCountByDayApiDto":{"title":"Form Submission Count By Day","description":"Form submission count by day response","properties":{"total":{"description":"Total","type":"integer","nullable":false},"date":{"description":"Date","type":"string","nullable":false}},"type":"object"},"SubmissionCreateApiDto":{"title":"Submission Create","description":"Response containing details of a newly created submission","properties":{"id":{"description":"The unique identifier of the created submission","type":"integer","nullable":false},"formId":{"description":"The unique identifier of the form this submission belongs to","type":"integer","nullable":false},"timestamp":{"description":"The date and time when the submission was created","type":"string","nullable":true},"userAgent":{"description":"The browser user agent string of the submitter","type":"string","nullable":true},"remoteAddr":{"description":"The IP address from which the submission was made","type":"string","nullable":true},"paymentStatus":{"description":"The current payment status if the form includes payment processing","type":"string","nullable":true},"latitude":{"description":"The GPS latitude coordinate if location data was captured","type":"string","nullable":true},"longitude":{"description":"The GPS longitude coordinate if location data was captured","type":"string","nullable":true},"data":{"description":"Array of field data contained in this submission","type":"array","items":{"$ref":"#/components/schemas/SubmissionDataApiDto"},"nullable":true}},"type":"object"},"SubmissionDataApiDto":{"title":"Submission Data","description":"Individual field data within a submission","properties":{"field":{"description":"The unique identifier of the field this data belongs to","type":"string","nullable":false},"label":{"description":"The display label/name of the field","type":"string","nullable":true},"type":{"description":"The field type (text, email, select, etc.)","type":"string","nullable":true},"internalLabel":{"description":"The internal label/alias of the field for API usage","type":"string","nullable":true},"displayValue":{"description":"The formatted display value of the field as it would appear to users","type":"string","nullable":true},"parsedValue":{"description":"The structured, parsed value of the field data based on field type","nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubmissionDataNameValueApiDto"},{"$ref":"#/components/schemas/SubmissionDataAddressValueApiDto"},{"$ref":"#/components/schemas/SubmissionDataDatetimeValueApiDto"},{"$ref":"#/components/schemas/SubmissionDataProductValueApiDto"},{"$ref":"#/components/schemas/SubmissionDataCheckboxValueApiDto"},{"$ref":"#/components/schemas/SubmissionDataRadioValueApiDto"},{"$ref":"#/components/schemas/SubmissionDataFileValueApiDto"},{"$ref":"#/components/schemas/SubmissionDataMatrixValueApiDto"},{"$ref":"#/components/schemas/SubmissionDataSelectValueApiDto"},{"$ref":"#/components/schemas/SubmissionDataSignatureValueApiDto"},{"$ref":"#/components/schemas/SubmissionDataCreditCardValueApiDto"}]}},"type":"object"},"SubmissionDeleteApiDto":{"title":"Submission Delete","description":"Submission delete response","properties":{"id":{"description":"The ID of the submission","type":"integer","nullable":false}},"type":"object"},"SubmissionDetailedApiDto":{"title":"Submission Detailed","description":"Comprehensive response containing all details of a submission","properties":{"id":{"description":"The unique identifier of the submission","type":"integer","nullable":true},"timestamp":{"description":"The date and time when the submission was created","type":"string","nullable":true},"userAgent":{"description":"The browser user agent string of the submitter","type":"string","nullable":true},"remoteAddr":{"description":"The IP address from which the submission was made","type":"string","nullable":true},"paymentStatus":{"description":"The current payment status if the form includes payment processing","type":"string","nullable":true},"formId":{"description":"The unique identifier of the form this submission belongs to","type":"integer","nullable":true},"latitude":{"description":"The GPS latitude coordinate if location data was captured","type":"string","nullable":true},"longitude":{"description":"The GPS longitude coordinate if location data was captured","type":"string","nullable":true},"approvalStatus":{"description":"The current approval status (Approved, Denied, or Pending) if approvals are enabled","type":"string","nullable":true},"portal":{"description":"Portal information if the submission was made through a portal","type":"array","items":{"$ref":"#/components/schemas/SubmissionPortalApiDto"},"nullable":true},"data":{"description":"Array of field data contained in this submission","type":"array","items":{"$ref":"#/components/schemas/SubmissionDataApiDto"},"nullable":true},"prettyFieldId":{"description":"The field ID used to generate a human-readable name for this submission","type":"integer","nullable":true},"workflow":{"description":"Workflow information if the submission is part of a workflow process","type":"array","items":{"$ref":"#/components/schemas/SubmissionWorkflowApiDto"},"nullable":true}},"type":"object"},"SubmissionEditApiDto":{"title":"Submission Edit","description":"Submission edit response","properties":{"id":{"description":"The ID of the submission","type":"integer","nullable":false},"formId":{"description":"ID of the submission form","type":"integer","nullable":false},"timestamp":{"description":"Timestamp of the submission","type":"string","nullable":true},"userAgent":{"description":"User agent of the submission","type":"string","nullable":true},"remoteAddr":{"description":"Remote addr of the submission","type":"string","nullable":true},"paymentStatus":{"description":"Payment status of the submission","type":"string","nullable":true},"read":{"description":"Read status of the submission","type":"string","nullable":true}},"type":"object"},"SubmissionPortalApiDto":{"title":"Submission Portal","description":"Submission portal response","properties":{"name":{"description":"Portal name of the submission","type":"string","nullable":true},"formName":{"description":"Portal form name of the submission","type":"string","nullable":true},"participantEmail":{"description":"Portal participant email of the submission","type":"string","nullable":true}},"type":"object"},"SubmissionWorkflowApiDto":{"title":"Submission Workflow","description":"Submission workflow response","properties":{"request_id":{"description":"The ID of the workflow request","type":"integer","nullable":true},"complete":{"description":"Is workflow completed","type":"boolean","nullable":true},"process_time":{"description":"Human-readable workflow process time. For completed workflows this is the time between submission start and completion; for in-progress workflows it is the time elapsed since submission start.","type":"string","nullable":true}},"type":"object"},"FormSubmissionPreviewApiDto":{"title":"Form Submission Preview","description":"Form submission preview response","properties":{"id":{"description":"The ID of the submission","type":"integer","nullable":false},"formId":{"description":"The ID of the submission form","type":"integer","nullable":false},"timestamp":{"description":"Timestamp of the submission","type":"string","nullable":false},"data":{"description":"Data of the submission (equals null also if this field isn't requested). Shape depends on the dataFormat request parameter: 'legacy' (default) returns an object keyed by field id, where each value has field, label, type, internal_label, value and (when expandData=true) flat_value; 'standardized' returns an array of field objects matching GET /submissions/{id}. The example shows the legacy (default) shape.","example":{"123456":{"field":"123456","label":"Email Address","type":"email","internal_label":"email","value":"john@example.com","flat_value":"john@example.com"},"123457":{"field":"123457","label":"Full Name","type":"name","internal_label":"full_name","value":"John Smith","flat_value":"John Smith"}},"nullable":true,"oneOf":[{"type":"object","additionalProperties":{"$ref":"#/components/schemas/FormSubmissionPreviewLegacyDataApiDto"}},{"type":"array","items":{"$ref":"#/components/schemas/FormSubmissionPreviewDataApiDto"}}]},"prettyName":{"description":"Pretty name of the submission (equals null also if this field isn't requested)","type":"string","nullable":true}},"type":"object"},"FormSubmissionPreviewDataApiDto":{"title":"Form Submission Preview Data","description":"Form submission preview data response","properties":{"field":{"description":"The unique identifier of the field this data belongs to","type":"string","nullable":false},"label":{"description":"The display label/name of the field","type":"string","nullable":true},"type":{"description":"The field type (text, email, select, etc.)","type":"string","nullable":true},"internalLabel":{"description":"The internal label/alias of the field for API usage","type":"string","nullable":true},"displayValue":{"description":"The formatted display value of the field as it would appear to users","type":"string","nullable":true},"parsedValue":{"description":"The structured, parsed value of the field data based on field type. Only present when expandData=true.","nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubmissionDataNameValueApiDto"},{"$ref":"#/components/schemas/SubmissionDataAddressValueApiDto"},{"$ref":"#/components/schemas/SubmissionDataDatetimeValueApiDto"},{"$ref":"#/components/schemas/SubmissionDataProductValueApiDto"},{"$ref":"#/components/schemas/SubmissionDataCheckboxValueApiDto"},{"$ref":"#/components/schemas/SubmissionDataRadioValueApiDto"},{"$ref":"#/components/schemas/SubmissionDataFileValueApiDto"},{"$ref":"#/components/schemas/SubmissionDataMatrixValueApiDto"},{"$ref":"#/components/schemas/SubmissionDataSelectValueApiDto"},{"$ref":"#/components/schemas/SubmissionDataSignatureValueApiDto"},{"$ref":"#/components/schemas/SubmissionDataCreditCardValueApiDto"}]}},"type":"object"},"FormSubmissionPreviewLegacyDataApiDto":{"title":"Form Submission Preview Data (legacy)","description":"Legacy form submission data item, keyed by field id in the response. Returned when dataFormat=legacy (the default).","properties":{"field":{"description":"The unique identifier of the field this data belongs to","type":"string","nullable":false},"label":{"description":"The display label/name of the field","type":"string","nullable":true},"type":{"description":"The field type (text, email, select, etc.)","type":"string","nullable":true},"internal_label":{"description":"The internal label/alias of the field for API usage","type":"string","nullable":true},"value":{"description":"The field value. When expandData is not set this is the flat/raw value; when expandData=true this is the structured, parsed value.","nullable":true},"flat_value":{"description":"The flat/raw value of the field. Only present when expandData=true.","type":"string","nullable":true}},"type":"object"},"FormSubmissionsListingApiDto":{"title":"Form Submissions Listing","description":"Form submissions listing response","properties":{"page":{"$ref":"#/components/schemas/PaginationApiDto"},"submissions":{"description":"Preview of form submission in list","type":"array","items":{"$ref":"#/components/schemas/FormSubmissionPreviewApiDto"},"nullable":true}},"type":"object"},"SubmissionPreviewApiDto":{"title":"Submission Preview","description":"Submission preview response","properties":{"id":{"description":"The ID of the submission","type":"integer","nullable":false},"formId":{"description":"The ID of the submission form","type":"integer","nullable":false},"timestamp":{"description":"Timestamp of the submission","type":"string","nullable":false},"data":{"description":"Data of the submission","type":"array","items":{"$ref":"#/components/schemas/SubmissionPreviewDataApiDto"},"nullable":true},"prettyName":{"description":"Pretty name of the submission","type":"string","nullable":true}},"type":"object"},"SubmissionPreviewDataApiDto":{"title":"Submission Preview Data","description":"Submission preview data response"},"SubmissionsListingApiDto":{"title":"Submissions Listing","description":"Submissions listing response","properties":{"page":{"$ref":"#/components/schemas/PaginationApiDto"},"submissions":{"description":"Preview of submission in list","type":"array","items":{"$ref":"#/components/schemas/SubmissionPreviewApiDto"},"nullable":true}},"type":"object"},"CountFormSubmissionsApiDto":{"title":"Count Form Submissions","description":"Count form submissions data","properties":{"startDate":{"description":"When to start submission count from.","type":"string","nullable":true},"lookbackPeriod":{"description":"How many days to count backwards from (maximum is 7 days).","type":"integer","nullable":true}},"type":"object"},"CreateSubmissionInputApiDto":{"title":"Create Submission","description":"Request payload for creating a new form submission","properties":{"fields":{"description":"Array of field data to be submitted with their values","type":"array","items":{"$ref":"#/components/schemas/SubmissionParsedFieldApiDto"},"nullable":false},"userAgent":{"description":"The browser user agent string of the submitter","type":"string","nullable":true},"remoteAddr":{"description":"The IP address from which the submission is being made","type":"string","nullable":true},"read":{"description":"Whether to mark the submission as read upon creation (true/false)","type":"string","nullable":true},"longitude":{"description":"The GPS longitude coordinate if location data is available","type":"string","nullable":true},"latitude":{"description":"The GPS latitude coordinate if location data is available","type":"string","nullable":true},"deviceId":{"description":"The unique device identifier if available from mobile submissions","type":"string","nullable":true}},"type":"object"},"EditSubmissionInputApiDto":{"title":"Edit Submission","description":"Edit Submission request","properties":{"fields":{"description":"Fields of the submission","type":"array","items":{"$ref":"#/components/schemas/SubmissionParsedFieldApiDto"},"nullable":false},"userAgent":{"description":"User agent of the submission","type":"string","nullable":true},"remoteAddr":{"description":"Remote addr of the submission","type":"string","nullable":true},"paymentStatus":{"description":"Payment status of the submission","type":"string","nullable":true},"read":{"description":"Flag to mark the submission as read","type":"string","nullable":true},"timestamp":{"description":"Timestamp of the submission","type":"string","nullable":true}},"type":"object"},"FileUploadUrlsInputApiDto":{"title":"File Upload URLs Input","description":"Request body for generating presigned S3 upload URLs for a file field.","properties":{"filenames":{"description":"Original filenames to generate upload targets for. One presigned URL is returned per filename.","type":"array","items":{"type":"string"},"maxItems":20,"minItems":1}},"type":"object"},"GetFormSubmissionsListApiDto":{"title":"Get Form Submissions List","description":"Get form submissions list params","properties":{"pageNumber":{"description":"Page to use when paginating through items.","type":"integer","minimum":1,"nullable":true},"pageSize":{"description":"Number of items to return per page.","type":"integer","default":50,"maximum":500,"minimum":10,"nullable":true},"order":{"description":"Order direction of results.","type":"string","default":"ASC","enum":["ASC","DESC"],"nullable":true},"keyword":{"description":"Keyword to search.","type":"string","nullable":true},"minTime":{"description":"Return submissions at and after given date/time - YYYY-MM-DD or YYYY-MM-DD HH:MM:SS expected (Based around Eastern Time).","type":"string","nullable":true},"maxTime":{"description":"Return submissions at and before given date/time - YYYY-MM-DD or YYYY-MM-DD HH:MM:SS expected (Based around Eastern Time).","type":"string","nullable":true},"search":{"description":"Array of search criteria to filter submissions by specific field values. Each criterion must include a fieldId and value. Maximum 10 search criteria allowed (index 0-9).","type":"array","items":{"$ref":"#/components/schemas/SearchCriterionDto"},"example":[{"fieldId":"123456","value":"john@example.com"},{"fieldId":"789012","value":"New York"}],"nullable":true},"data":{"description":"Flag to include submission data.","type":"string","nullable":true},"expandData":{"description":"Flag to expand submission data.","type":"string","nullable":true},"prettyName":{"description":"Flag to include pretty name.","type":"string","nullable":true},"dataFormat":{"description":"Shape of the 'data' field when data=true. 'legacy' (default): map keyed by field id with value/flat_value/internal_label. 'standardized': array of field objects matching GET /submissions/{id} with displayValue/parsedValue/internalLabel.","type":"string","default":"legacy","enum":["legacy","standardized"],"nullable":true}},"type":"object"},"GetSubmissionUploadApiDto":{"title":"Get Submission Upload","description":"Request parameters for retrieving uploaded files from submissions","properties":{"fieldId":{"description":"The unique identifier of the field containing the uploaded file","type":"integer","nullable":false},"index":{"description":"The index of the file when multiple files are uploaded to the same field (zero-based)","type":"integer","nullable":true}},"type":"object"},"GetSubmissionsListApiDto":{"title":"Get Submissions List","description":"Get submissions list params","properties":{"pageNumber":{"description":"Page to use when paginating through items.","type":"integer","minimum":1,"nullable":true},"pageSize":{"description":"Number of items to return per page.","type":"integer","default":50,"maximum":500,"minimum":10,"nullable":true},"search":{"description":"String to search for.","type":"string","nullable":false},"order":{"description":"Order direction of results.","type":"string","default":"ASC","enum":["ASC","DESC"],"nullable":true}},"type":"object"},"SubmissionParsedFieldAddressValueApiDto":{"title":"Submission Parsed Field Address Value","description":"Submission parsed field address value","properties":{"address":{"description":"First part of the address","type":"string","nullable":true},"address2":{"description":"Second part of the address","type":"string","nullable":true},"city":{"description":"City of the address","type":"string","nullable":true},"country":{"description":"Country of the address","type":"string","nullable":true},"state":{"description":"State of the address","type":"string","nullable":true},"zip":{"description":"Zip of the address","type":"string","nullable":true}},"type":"object"},"SubmissionParsedFieldCheckboxValueApiDto":{"title":"Submission Parsed Field Checkbox Value","description":"Submission parsed field checkbox value","type":"object","allOf":[{"$ref":"#/components/schemas/SubmissionParsedFieldSubValuesApiDto"},{"properties":{"subvalues":{"description":"Subvalues of the checkbox field","type":"array","items":{"$ref":"#/components/schemas/SubmissionParsedFieldSubValueApiDto"},"nullable":true}},"type":"object"}]},"SubmissionParsedFieldCreditCardValueApiDto":{"title":"Submission Parsed Field Credit Card Value","description":"Submission parsed field credit card value","properties":{"card":{"description":"Number of the credit card","type":"string","nullable":true},"cardexp":{"description":"Expiration date of the credit card","type":"string","nullable":true}},"type":"object"},"SubmissionParsedFieldDatetimeValueApiDto":{"title":"Submission Parsed Field Datetime Value","description":"Submission parsed field datetime value","type":"object","allOf":[{"$ref":"#/components/schemas/SubmissionParsedFieldSingleValueApiDto"},{"properties":{"value":{"description":"Value of the datetime field","type":"string","nullable":true}},"type":"object"}]},"SubmissionParsedFieldEmailValueApiDto":{"title":"Submission Parsed Field Email Value","description":"Submission parsed field email value","type":"object","allOf":[{"$ref":"#/components/schemas/SubmissionParsedFieldSingleValueApiDto"},{"properties":{"value":{"description":"Value of the email field","type":"string","nullable":true}},"type":"object"}]},"SubmissionParsedFieldFileValueApiDto":{"title":"Submission Parsed Field File Value","description":"Submission parsed field file value","type":"object","allOf":[{"$ref":"#/components/schemas/SubmissionParsedFieldSubValuesApiDto"},{"properties":{"subvalues":{"description":"Subvalues of the file field. Each subvalue is one file, supplied as either \"filename;base64data\" (the file embedded inline, bounded by the request body size limit) or a presigned `fileKey` returned by POST /forms/{formId}/fields/{fieldId}/upload-urls after the file has been uploaded directly to S3 (recommended for large files). To attach multiple files, send one subvalue per file. All subvalues within the field must use the same style — either all inline base64 or all presigned `fileKey`s; mixing the two in one field is rejected.","type":"array","items":{"$ref":"#/components/schemas/SubmissionParsedFieldSubValueApiDto"},"nullable":true}},"type":"object"}]},"SubmissionParsedFieldMatrixValueApiDto":{"title":"Submission Parsed Field Matrix Value","description":"Submission parsed field matrix value","type":"object","allOf":[{"$ref":"#/components/schemas/SubmissionParsedFieldSubValuesApiDto"},{"properties":{"subvalues":{"description":"Subvalues of the matrix field","type":"array","items":{"$ref":"#/components/schemas/SubmissionParsedFieldSubValueApiDto"},"nullable":true}},"type":"object"}]},"SubmissionParsedFieldNameValueApiDto":{"title":"Submission Parsed Field Name Value","description":"Submission parsed field name value","properties":{"prefix":{"description":"Prefix of the name","type":"string","nullable":true},"first":{"description":"First name of the name","type":"string","nullable":true},"initial":{"description":"Initial of the name","type":"string","nullable":true},"middle":{"description":"Middle of the name","type":"string","nullable":true},"last":{"description":"Last name of the name","type":"string","nullable":true},"suffix":{"description":"Suffix of the name","type":"string","nullable":true}},"type":"object"},"SubmissionParsedFieldNumberValueApiDto":{"title":"Submission Parsed Field Number Value","description":"Submission parsed field number value","type":"object","allOf":[{"$ref":"#/components/schemas/SubmissionParsedFieldSingleValueApiDto"},{"properties":{"value":{"description":"Value of the number field","type":"string","nullable":true}},"type":"object"}]},"SubmissionParsedFieldPhoneValueApiDto":{"title":"Submission Parsed Field Phone Value","description":"Submission parsed field phone value","type":"object","allOf":[{"$ref":"#/components/schemas/SubmissionParsedFieldSingleValueApiDto"},{"properties":{"value":{"description":"Value of the phone field","type":"string","nullable":true}},"type":"object"}]},"SubmissionParsedFieldProductValueApiDto":{"title":"Submission Parsed Field Product Value","description":"Submission parsed field product value","properties":{"chargeType":{"description":"ChargeType of the product","type":"string","nullable":false},"quantity":{"description":"Quantity of the product","type":"string","nullable":true},"total":{"description":"Total of the product","type":"string","nullable":true},"unitPrice":{"description":"UnitPrice of the product","type":"string","nullable":true}},"type":"object"},"SubmissionParsedFieldRadioValueApiDto":{"title":"Submission Parsed Field Radio Value","description":"Submission parsed field radio value","type":"object","allOf":[{"$ref":"#/components/schemas/SubmissionParsedFieldSingleValueApiDto"},{"properties":{"value":{"description":"Value of the radio field","type":"string","nullable":true}},"type":"object"}]},"SubmissionParsedFieldRatingValueApiDto":{"title":"Submission Parsed Field Rating Value","description":"Submission parsed field rating value","type":"object","allOf":[{"$ref":"#/components/schemas/SubmissionParsedFieldSingleValueApiDto"},{"properties":{"value":{"description":"Value of the rating field","type":"string","nullable":true}},"type":"object"}]},"SubmissionParsedFieldSelectValueApiDto":{"title":"Submission Parsed Field Select Value","description":"Submission parsed field select value","type":"object","allOf":[{"$ref":"#/components/schemas/SubmissionParsedFieldSubValuesApiDto"},{"properties":{"subvalues":{"description":"Subvalues of the select field","type":"array","items":{"$ref":"#/components/schemas/SubmissionParsedFieldSubValueApiDto"},"nullable":true}},"type":"object"}]},"SubmissionParsedFieldSignatureValueApiDto":{"title":"Submission Parsed Field Signature Value","description":"Submission parsed field signature value","type":"object","allOf":[{"$ref":"#/components/schemas/SubmissionParsedFieldSubValuesApiDto"},{"properties":{"subvalues":{"description":"Subvalues of the signature field","type":"array","items":{"$ref":"#/components/schemas/SubmissionParsedFieldSubValueApiDto"},"nullable":true}},"type":"object"}]},"SubmissionParsedFieldSingleValueApiDto":{"title":"Submission Parsed Field Single Value","description":"Submission parsed field single value","properties":{"value":{"description":"Value of the submissions field","type":"string","nullable":true}},"type":"object"},"SubmissionParsedFieldSubValueApiDto":{"title":"Submission Parsed Field SubValue","description":"Submission parsed field subvalue","properties":{"subvalue":{"description":"Subvalue of the submission field","type":"string","nullable":true}},"type":"object"},"SubmissionParsedFieldSubValuesApiDto":{"title":"Submission Parsed Field SubValues","description":"Submission parsed field subvalues","properties":{"subvalues":{"description":"Subvalues of the submission field","type":"array","items":{"$ref":"#/components/schemas/SubmissionParsedFieldSubValueApiDto"},"nullable":true}},"type":"object"},"SubmissionParsedFieldTableCellValueApiDto":{"title":"Submission Parsed Field Table Cell Value","description":"Submission parsed field table cell value","type":"object","allOf":[{"$ref":"#/components/schemas/SubmissionParsedFieldSingleValueApiDto"},{"properties":{"value":{"description":"Value of the table cell field","type":"string","nullable":true}},"type":"object"}]},"SubmissionParsedFieldTextValueApiDto":{"title":"Submission Parsed Field Text Value","description":"Submission parsed field text value","type":"object","allOf":[{"$ref":"#/components/schemas/SubmissionParsedFieldSingleValueApiDto"},{"properties":{"value":{"description":"Value of the text field","type":"string","nullable":true}},"type":"object"}]},"SubmissionParsedFieldTextareaValueApiDto":{"title":"Submission Parsed Field Textarea Value","description":"Submission parsed field textarea value","type":"object","allOf":[{"$ref":"#/components/schemas/SubmissionParsedFieldSingleValueApiDto"},{"properties":{"value":{"description":"Value of the textarea field","type":"string","nullable":true}},"type":"object"}]},"SubmissionParsedFieldApiDto":{"title":"Submission Parsed Field","description":"Submission parsed field","properties":{"id":{"description":"Id of the submission field","type":"string","nullable":false},"value":{"description":"Value of the submission field","nullable":true,"oneOf":[{"$ref":"#/components/schemas/SubmissionParsedFieldTextValueApiDto"},{"$ref":"#/components/schemas/SubmissionParsedFieldNameValueApiDto"},{"$ref":"#/components/schemas/SubmissionParsedFieldAddressValueApiDto"},{"$ref":"#/components/schemas/SubmissionParsedFieldCreditCardValueApiDto"},{"$ref":"#/components/schemas/SubmissionParsedFieldProductValueApiDto"},{"$ref":"#/components/schemas/SubmissionParsedFieldTableCellValueApiDto"},{"$ref":"#/components/schemas/SubmissionParsedFieldDatetimeValueApiDto"},{"$ref":"#/components/schemas/SubmissionParsedFieldRatingValueApiDto"},{"$ref":"#/components/schemas/SubmissionParsedFieldRadioValueApiDto"},{"$ref":"#/components/schemas/SubmissionParsedFieldNumberValueApiDto"},{"$ref":"#/components/schemas/SubmissionParsedFieldPhoneValueApiDto"},{"$ref":"#/components/schemas/SubmissionParsedFieldEmailValueApiDto"},{"$ref":"#/components/schemas/SubmissionParsedFieldTextareaValueApiDto"},{"$ref":"#/components/schemas/SubmissionParsedFieldMatrixValueApiDto"},{"$ref":"#/components/schemas/SubmissionParsedFieldSignatureValueApiDto"},{"$ref":"#/components/schemas/SubmissionParsedFieldFileValueApiDto"},{"$ref":"#/components/schemas/SubmissionParsedFieldCheckboxValueApiDto"},{"$ref":"#/components/schemas/SubmissionParsedFieldSelectValueApiDto"}]}},"type":"object"},"SubmitActionDetailedApiDto":{"title":"Submit Action Details","description":"Complete details of a form submit action including configuration and logic conditions","properties":{"id":{"description":"Unique identifier for the submit action","type":"integer","nullable":false},"name":{"description":"Display name for the submit action","type":"string","nullable":true},"type":{"description":"Type of action to perform after form submission: 'default' for standard processing, 'message' to display custom content, or 'redirect' to navigate to a URL","type":"string","enum":["default","message","redirect"],"nullable":false},"message":{"description":"HTML content to display to users when type is 'message'","type":"string","nullable":true},"url":{"description":"Target URL to redirect users to when type is 'redirect'","type":"string","format":"uri","nullable":true},"append_data":{"description":"Whether to append form submission data as query parameters to the redirect URL","type":"boolean","nullable":true},"logic":{"oneOf":[{"$ref":"#/components/schemas/LogicDto"}],"nullable":true,"description":"Conditional logic rules that determine when this submit action should be executed based on form field values"}},"type":"object"},"SubmitActionPreviewApiDto":{"title":"Submit Action Preview","description":"Summary information for a submit action, used in listings and previews","properties":{"id":{"description":"Unique identifier for the submit action","type":"integer","nullable":false},"name":{"description":"Display name for the submit action","type":"string","nullable":true},"type":{"description":"Type of action to perform after form submission: 'default' for standard processing, 'message' to display custom content, or 'redirect' to navigate to a URL","type":"string","enum":["default","message","redirect"],"nullable":false},"message":{"description":"HTML content to display to users when type is 'message'","type":"string","nullable":true},"url":{"description":"Target URL to redirect users to when type is 'redirect'","type":"string","format":"uri","nullable":true},"append_data":{"description":"Whether to append form submission data as query parameters to the redirect URL","type":"boolean","nullable":true},"logic":{"oneOf":[{"$ref":"#/components/schemas/LogicDto"}],"nullable":true,"description":"Conditional logic rules that determine when this submit action should be executed based on form field values"}},"type":"object"},"SubmitActionsListingApiDto":{"title":"Submit Actions Listing","description":"Collection of submit actions configured for a form","properties":{"submitactions":{"description":"Array of submit actions configured for the form","type":"array","items":{"$ref":"#/components/schemas/SubmitActionPreviewApiDto"},"nullable":false}},"type":"object"},"CreateSubmitActionInputApiDto":{"title":"Create Submit Action","description":"Request payload for creating a new submit action on a form","properties":{"name":{"description":"Display name for the submit action","type":"string","nullable":true},"type":{"description":"Type of action to perform after form submission: 'default' for standard processing, 'message' to display custom content, or 'redirect' to navigate to a URL","type":"string","enum":["default","message","redirect"],"nullable":false},"message":{"description":"HTML content to display to users (required when type is 'message')","type":"string","nullable":true},"url":{"description":"Target URL to redirect users to (required when type is 'redirect')","type":"string","format":"uri","nullable":true},"append_data":{"description":"Whether to append form submission data as query parameters to the redirect URL","type":"boolean","default":false,"nullable":true},"logic":{"oneOf":[{"$ref":"#/components/schemas/LogicDto"}],"nullable":true,"description":"Conditional logic rules that determine when this submit action should be executed based on form field values"}},"type":"object"},"EditSubmitActionInputApiDto":{"title":"Edit Submit Action","description":"Request payload for updating an existing submit action","properties":{"name":{"description":"Display name for the submit action","type":"string","nullable":true},"type":{"description":"Type of action to perform after form submission: 'default' for standard processing, 'message' to display custom content, or 'redirect' to navigate to a URL","type":"string","enum":["default","message","redirect"],"nullable":false},"message":{"description":"HTML content to display to users (required when type is 'message')","type":"string","nullable":true},"url":{"description":"Target URL to redirect users to (required when type is 'redirect')","type":"string","format":"uri","nullable":true},"append_data":{"description":"Whether to append form submission data as query parameters to the redirect URL","type":"boolean","default":false,"nullable":true},"logic":{"oneOf":[{"$ref":"#/components/schemas/LogicDto"}],"nullable":true,"description":"Conditional logic rules that determine when this submit action should be executed based on form field values"}},"type":"object"},"FormThemeAssignDto":{"title":"Form Theme Assignment Response","description":"Response after successfully assigning a theme to a form","properties":{"success":{"description":"Indicates if the theme assignment was successful","type":"boolean","nullable":false},"formId":{"description":"The ID of the form that received the theme","type":"string","nullable":false},"formName":{"description":"The name of the form that received the theme","type":"string","nullable":false},"currentThemeId":{"description":"The ID of the newly assigned theme","type":"string","nullable":false},"currentThemeName":{"description":"The name of the newly assigned theme","type":"string","nullable":false},"isCurrentThemeStock":{"description":"Indicates if the newly assigned theme is a stock theme","type":"boolean","nullable":false},"previousThemeId":{"description":"The ID of the theme that was previously assigned","type":"string","nullable":false},"previousThemeName":{"description":"The name of the theme that was previously assigned","type":"string","nullable":false},"isPreviousThemeStock":{"description":"Indicates if the previously assigned theme was a stock theme","type":"boolean","nullable":false}},"type":"object"},"ThemeDeleteDto":{"title":"Theme Delete Response","description":"Response after successfully deleting a theme","properties":{"deleted":{"description":"Indicates if the theme was successfully deleted","type":"boolean","nullable":false},"themeId":{"description":"The ID of the deleted theme","type":"string","nullable":false},"themeName":{"description":"The name of the deleted theme","type":"string","nullable":false},"formsAffected":{"description":"Number of forms that were using this theme","type":"integer","nullable":false},"fallbackThemeId":{"description":"The ID of the theme that forms were switched to","type":"string","nullable":false},"fallbackThemeName":{"description":"The name of the theme that forms were switched to","type":"string","nullable":false},"isStockFallback":{"description":"Indicates if the fallback theme is a stock theme","type":"boolean","nullable":false}},"type":"object"},"ThemeDto":{"title":"Theme Details","description":"Represents detailed theme information","properties":{"id":{"description":"The ID of the theme","type":"string","nullable":false},"name":{"description":"The name of the theme","type":"string","nullable":false},"created":{"description":"Theme creation date","type":"string","format":"date-time","nullable":true},"updated":{"description":"Theme last update date","type":"string","format":"date-time","nullable":true},"version":{"description":"Theme version","type":"integer","nullable":true},"stockTemplate":{"description":"Whether this is a stock template","type":"boolean","nullable":false},"usage":{"description":"Number of forms using this theme","type":"integer","nullable":true},"isDefault":{"description":"Whether this is the default theme for the account","type":"boolean","nullable":false}},"type":"object"},"ThemeIdApiDto":{"title":"Theme ID Response","description":"Represents a theme ID in responses","properties":{"id":{"description":"The ID of the theme","type":"string","nullable":false}},"type":"object"},"ThemeListDto":{"title":"Theme List Response","description":"Paginated list of themes with metadata","properties":{"page":{"$ref":"#/components/schemas/PaginationApiDto"},"themes":{"description":"Array of theme details","type":"array","items":{"$ref":"#/components/schemas/ThemeDto"},"nullable":false}},"type":"object"},"AssignThemeToFormApiDto":{"title":"Assign Theme to Form Request","description":"Request data for assigning a theme to a form","properties":{"themeId":{"description":"The ID of the theme to assign to the form","type":"string","example":"light","nullable":false}},"type":"object"},"GetThemeFormListApiDto":{"title":"Get Theme Form List Request","description":"Request parameters for getting a paginated list of forms using a specific theme","properties":{"pageNumber":{"description":"Page number (1-based)","type":"integer","default":1,"minimum":1,"nullable":true},"pageSize":{"description":"Number of items per page (10-100)","type":"integer","default":25,"maximum":100,"minimum":10,"nullable":true}},"type":"object"},"GetThemeListApiDto":{"title":"Get Theme List Request","description":"Request parameters for getting a paginated list of themes","properties":{"pageNumber":{"description":"Page number (1-based)","type":"integer","default":1,"minimum":1,"nullable":true},"pageSize":{"description":"Number of items per page (10-100)","type":"integer","default":25,"maximum":100,"minimum":10,"nullable":true}},"type":"object"},"WebhookDetailedApiDto":{"title":"Webhook Detailed","description":"Webhook detailed information","properties":{"id":{"description":"ID of the webhook","type":"integer","nullable":false},"name":{"description":"Name of the webhook","type":"string","nullable":false},"formId":{"description":"ID of the form","type":"integer","nullable":false},"url":{"description":"URL to send the webhook data to","type":"string","format":"uri","nullable":false},"contentType":{"description":"Content type of the webhook data (urlencoded or json)","type":"string","enum":["urlencoded","json"],"nullable":false},"fileTransferType":{"description":"Method for transferring file data in webhook payloads","type":"string","enum":["downloadLink","signedUrl","base64encode"],"nullable":false},"postDataFieldKeys":{"description":"Format of field keys in POST data","type":"string","enum":["field_names","field_ids","api_friendly_field_names","internal_labels","internal_labels_api_friendly"],"nullable":false},"useFieldIds":{"description":"Whether to use field IDs instead of field names (legacy format)","type":"boolean","nullable":false},"sharedSecret":{"description":"Shared secret for the webhook","type":"string","nullable":true},"hmacSecret":{"description":"HMAC secret used for signing webhook payload data","type":"string","nullable":true},"customHmacHeader":{"description":"Custom HMAC header name","type":"string","nullable":true},"errorEmails":{"description":"Comma-separated email addresses to notify when webhook delivery fails","type":"string","nullable":true},"includeFieldType":{"description":"Whether to include field type information in the webhook data","type":"boolean","nullable":false},"includeSubfieldNames":{"description":"Whether to include subfield names in the webhook data","type":"boolean","nullable":false},"standardizeValues":{"description":"Whether to standardize field values in the webhook data","type":"boolean","nullable":false},"customerApprovedPciCompliant":{"description":"Whether the webhook has been approved for PCI compliance","type":"boolean","nullable":false},"logic":{"oneOf":[{"$ref":"#/components/schemas/LogicDto"}],"nullable":true,"description":"Logic conditions for when to execute the webhook"}},"type":"object"},"WebhookOpenApiDefinitionDto":{"title":"Webhook OpenAPI Definition","description":"OpenAPI definition for a form's webhook payload structure","properties":{"type":{"description":"Schema type (always 'object')","type":"string","example":"object"},"properties":{"description":"Schema properties defining webhook payload structure","type":"object","example":{"FormID":{"type":"string"},"UniqueID":{"type":"string"},"Name":{"type":"string"},"Email":{"type":"string"},"Message":{"type":"string"}},"additionalProperties":true}},"type":"object"},"WebhooksListingApiDto":{"title":"Webhooks Listing","description":"List of webhooks","properties":{"webhooks":{"description":"List of webhooks","type":"array","items":{"$ref":"#/components/schemas/WebhookDetailedApiDto"}}},"type":"object"},"CreateWebhookInputApiDto":{"title":"Create Webhook","description":"Create Webhook request","allOf":[{"$ref":"#/components/schemas/WebhookInputApiDto"}]},"EditWebhookInputApiDto":{"title":"Edit Webhook","description":"Edit Webhook request","allOf":[{"$ref":"#/components/schemas/WebhookInputApiDto"}]},"WebhookInputApiDto":{"title":"Base Webhook Input","description":"Base Webhook Input properties","properties":{"name":{"description":"Name of the webhook","type":"string","nullable":false},"url":{"description":"URL to send the webhook data to","type":"string","format":"uri","nullable":false},"contentType":{"description":"Content type of the webhook data (urlencoded or json)","type":"string","default":"urlencoded","enum":["urlencoded","json"],"nullable":true},"fileTransferType":{"description":"Method for transferring file data in webhook payloads","type":"string","default":"downloadLink","enum":["downloadLink","signedUrl","base64encode"],"nullable":true},"postDataFieldKeys":{"description":"Format of field keys in POST data","type":"string","default":"field_names","enum":["field_names","field_ids","api_friendly_field_names","internal_labels","internal_labels_api_friendly"],"nullable":true},"sharedSecret":{"description":"Shared secret for the webhook","type":"string","nullable":true},"hmacSecret":{"description":"HMAC secret used for signing webhook payload data","type":"string","nullable":true},"customHmacHeader":{"description":"Custom HMAC header name","type":"string","nullable":true},"errorEmails":{"description":"Comma-separated email addresses to notify when webhook delivery fails","type":"string","nullable":true},"includeFieldType":{"description":"Whether to include field type information in the webhook data","type":"boolean","default":false,"nullable":true},"includeSubfieldNames":{"description":"Whether to include subfield names in the webhook data","type":"boolean","default":true,"nullable":true},"standardizeValues":{"description":"Whether to standardize field values in the webhook data for consistency","type":"boolean","default":false,"nullable":true},"customerApprovedPciCompliant":{"description":"Whether the webhook has been approved for PCI compliance","type":"boolean","default":false,"nullable":true},"logic":{"oneOf":[{"$ref":"#/components/schemas/LogicDto"}],"nullable":true,"description":"Logic conditions for when to execute the webhook"}},"type":"object"}}},"tags":[{"name":"Forms","description":"Forms are the core resource of the Formstack API. Use these endpoints to create, retrieve, update, copy, and delete forms, list the forms in an account with filtering and sorting, generate prefilled form URLs, and fetch the embed JavaScript or rendered HTML for a form. Most other resources—fields, submissions, emails, and submit actions—are scoped to a form."},{"name":"Fields","description":"Fields define what a form collects. Use these endpoints to list a form's fields and to create, retrieve, update, and delete individual fields. Field configuration covers labels, types, validation, default values, conditional logic, and layout."},{"name":"Submissions","description":"Submissions are the entries collected by your forms. Use these endpoints to create a submission, list submissions across all forms or for a specific form, count submissions, retrieve a single submission's data, edit or delete a submission, download uploaded files, and generate presigned URLs for direct file uploads. Results support pagination, date ranges, and field-level search."},{"name":"PartialSubmissions","description":"Partial submissions capture form data that a respondent entered but did not finish submitting (Save & Resume / abandoned entries). Use these endpoints to list and search a form's partial submissions, retrieve the details of one, and delete partial submissions."},{"name":"Folders","description":"Folders organize the forms in an account. Use these endpoints to list folders, retrieve a folder, and create, rename, or delete folders. The API exposes a single level of nesting (a folder and its direct subfolders)."},{"name":"Themes","description":"Themes control the visual styling applied to forms. Use these endpoints to list the themes in an account, copy a theme, delete a theme, list the forms using a theme, and assign a theme to a form. Deleting a theme switches its forms to the default theme."},{"name":"Confirmation Emails","description":"Confirmation emails are the messages sent to the person who submits a form. Use these endpoints to list a form's confirmation emails and to create, retrieve, update, and delete them, including subject, sender, content, send delay, and conditional logic."},{"name":"Notification Emails","description":"Notification emails alert your team when a form is submitted. Use these endpoints to list a form's notification emails and to create, retrieve, update, and delete them, including recipients, sender, subject, message content, file-attachment limits, and conditional logic."},{"name":"Submit Actions","description":"Submit actions define what happens after a form is submitted—standard processing, displaying a custom message, redirecting to a URL, or running a third-party integration such as WebMerge. Use these endpoints to list a form's submit actions and to create, retrieve, update, and delete them, including the conditional logic that controls when each action runs."},{"name":"Webhook","description":"Webhooks push submission data to an external URL in real time as forms are submitted. Use these endpoints to list a form's webhooks and to create, retrieve, update, and delete them, configure payload format, HMAC signing, and failure notifications, and fetch the generated OpenAPI definition describing a webhook's payload."},{"name":"Smart List","description":"Smart Lists are reusable sets of options that can be shared across fields and forms, so option sets are maintained in one place rather than per field. Use these endpoints to list smart lists and to create, retrieve, update, and delete a smart list."},{"name":"Smart List Options","description":"Smart List Options are the individual entries that make up a Smart List. Use these endpoints to list a smart list's options, add, retrieve, update, and delete an option, clear all of a list's options, bulk-add a set of options to a list, and upload or remove an option's image."},{"name":"Portals","description":"Portals provide a branded hub where users access a curated collection of forms. Use these endpoints to manage a portal and its forms and users—copying (to create new portals), editing, and deleting portals, adding, editing, and removing portal forms, managing portal users, and setting or removing the portal avatar."},{"name":"Subaccounts","description":"Subaccounts let a parent account manage separate child accounts. Use these endpoints to list subaccounts and to work with subaccount-scoped resources: copy a form into a subaccount, list a subaccount's themes, copy or delete a subaccount theme, list the forms using a subaccount theme, and assign a theme to a subaccount form. Subaccount records include details such as SMTP credentials."},{"name":"Classic","description":"Classic"}]}