GET webapi/root/Forms

Gets currently used Form for a Site. Scope Site.Name:{SiteName} must be granted to retrieve the information (in other words - Form can only be retrieved within the scope of a single Site).

Response Information

Response body formats

application/json, text/json

Sample: 
{
  "FormID": "4965ae8c-15b5-4b92-b9b9-790e4e0b3b73",
  "Name": "Contact - Basic",
  "Description": "Contact form that gathers basic contact information",
  "InstructionsTopText": "Please fill out the form to contact me",
  "InstructionsBottomText": "We will contact you shortly after we receive your information",
  "SubmitButtonText": "Submit contact information",
  "ConfirmationText": "I have received your contact information. Thank you.",
  "ResultsEmailAddress": "[email protected]",
  "StoreResultsInDatabase": true,
  "IsLocked": false,
  "CreatedTime": "2023-05-26T12:53:49.323",
  "UpdatedTime": "2024-10-01T21:22:23.593",
  "SiteName": "craftingcheetah",
  "FileName": "0.0.DefaultForm.xml",
  "HideVideoChat": false,
  "SubmitProviderEnabled": false,
  "SubmitProviderUrl": "",
  "SubmitProviderKeyValues": "",
  "SubmitProviderHeaders": "",
  "SubmitProviderSuccessKeyword": "",
  "JornayaEnabled": false,
  "JornayaCampaignID": "",
  "JornayaDisclosureText": "",
  "JornayaDisclosureNoInteraction": false,
  "TrustedFormEnabled": false,
  "TrustedFormFieldName": "xxTrustedFormCertUrl",
  "TrustedFormIdentifier": "jK5lSbUV",
  "TrustedFormIsSandbox": false
}

application/xml, text/xml

Sample: 
<Form xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MediaLibrarianCore">
  <ConfirmationText>I have received your contact information. Thank you.</ConfirmationText>
  <CreatedTime>2023-05-26T12:53:49.323</CreatedTime>
  <Description>Contact form that gathers basic contact information</Description>
  <FileName>0.0.DefaultForm.xml</FileName>
  <FormID>4965ae8c-15b5-4b92-b9b9-790e4e0b3b73</FormID>
  <HideVideoChat>false</HideVideoChat>
  <InstructionsBottomText>We will contact you shortly after we receive your information</InstructionsBottomText>
  <InstructionsTopText>Please fill out the form to contact me</InstructionsTopText>
  <IsLocked>false</IsLocked>
  <JornayaCampaignID></JornayaCampaignID>
  <JornayaDisclosureNoInteraction>false</JornayaDisclosureNoInteraction>
  <JornayaDisclosureText></JornayaDisclosureText>
  <JornayaEnabled>false</JornayaEnabled>
  <Name>Contact - Basic</Name>
  <ResultsEmailAddress>[email protected]</ResultsEmailAddress>
  <SiteName>craftingcheetah</SiteName>
  <StoreResultsInDatabase>true</StoreResultsInDatabase>
  <SubmitButtonText>Submit contact information</SubmitButtonText>
  <SubmitProviderEnabled>false</SubmitProviderEnabled>
  <SubmitProviderHeaders></SubmitProviderHeaders>
  <SubmitProviderKeyValues></SubmitProviderKeyValues>
  <SubmitProviderSuccessKeyword></SubmitProviderSuccessKeyword>
  <SubmitProviderUrl></SubmitProviderUrl>
  <TrustedFormEnabled>false</TrustedFormEnabled>
  <TrustedFormFieldName>xxTrustedFormCertUrl</TrustedFormFieldName>
  <TrustedFormIdentifier>jK5lSbUV</TrustedFormIdentifier>
  <TrustedFormIsSandbox>false</TrustedFormIsSandbox>
  <UpdatedTime>2024-10-01T21:22:23.593</UpdatedTime>
</Form>