A newer version of

Freeform

is available.

Try Freeform 5 now →

User Guides

Rendering Form Data as JSON

For convenience, you can render the form data as a JSON string, which comes in handy when you need to get values such as the form hash, CSRF token, honeypot input, etc. You might need to do this when you are caching your forms and want to update these values via a JS API call.

Instructions

Here's an example in Twig:

{% set form = craft.freeform.form('myForm') %}
{{ form.json }}
1
2

Here's the output:

{
    "hash":"oqpmq7EOZ-qkJrqXQR1-HJxxvibFh9QywmSSP54QHteCo0tqb4BQ5wJ1YN1E",
    "handle":"myForm",
    "ajax":true,
    "disableSubmit":true,
    "disableReset":false,
    "showSpinner":true,
    "showLoadingText":true,
    "loadingText":"Loading...",
    "class":"",
    "method":"post",
    "enctype":"multipart\/form-data",
    "successMessage":"Form has been submitted successfully!",
    "errorMessage":"Sorry, there was an error submitting the form. Please try again.",
    "honeypot":{
        "name":"freeform_form_handle",
        "value":""
    },
    "freeform_payload":"E0QZJ3Yq+j27yM1C9yUdymQ4OTAwZDUxNTdhNWUxZjJmNmRiZDUzOTZjODI4ZjMwODhjYzE4OWJmOTJkYWM2OTg0ZmQ2ZWYwZTA0ZjU5NjcZ\/uhuhfrLZt\/3n\/SNp2+GTQ7P5ngUQvd3I08vjwcQQKnlaWBhvI86XNAu7WrE8SNhx45cNUYdfAwHZujwNJ7x0swTsF8+sBExqRIamNOZCf4NkpiF0zrZJyhml0NcXyc761B0fABI+opRKTBDFwfCDtXaOV+rKp7pRPCfD\/nismR4aBvL+NDUa93qPnhnAgN6hTnryvIP\/cgoleJNdr3wRKxc6JalXahbIZaGiyJ0pXqzOpOHtuZy+rAzNdq4cI4LoAmFtKilOPF\/71Dv2y\/xJhhH9iwj+mVxxLLxYTN2VtdL6EnVn3oY5Sol5KhQM+nzVuLmYHJrl\/1aMpphYCckYx2N9qYv5vCeRWugIDl+peVMFHPraahwu7d+Z13LvIs=",
    "anchor":"8e3132-form-oqpmq7EOZ-qkJrqXQR1-HJxxvibFh9QywmSSP54QHteCo0tqb4BQ5wJ1YN1E",
    "csrf":{
        "name":"CRAFT_CSRF_TOKEN",
        "token":"Ndu_5xjemgxhkC-pl3pna6NaSdlBrF1O0LgfA_BHt85mE-D2qBwJ35FM4h2EGFiGHUDsNzAST2L5Xx8wVnUlR4Icl-CFhciXqRPad-WmMQiM1CANpuXc5bVPKMvVk_iCcLhNoLCuCA8vVECxGbtF-ECj2N5Dp06S74UvUuv66zyOfgr5lWGdcEzU-q1yKoe66kGQYzdjwPWbMAQ4QHoDE31jGQF4LV-d6Sv1X1hML5T9lbs2rLI_CEflTkMEUw7gjN9bsHoY7uniIYI4d234jUaQia9PhqpcMadLnLoVNzzhHDGqEMptBZv3LUa_P937JSaVs89YRu7tKYQktnpstHx43VYJJC1RwDsnAW9FEX-zfqTWtLf48Zp16UOBw1dtuuJGbJLS5dDRLhv85PWeukCILJGEzzpuGicLh1HsHcgQ8--6doohwrjHaSqYq40MxTVFy9Au5Rp5l8_YN03D9ds9oR8TUbnRqgMgASpINVgvGU9XLno05bAagSoeKEbHmM32Bv7cVG8Sgn07cztfpe-SdcYfctyo21jFVxgPr94="
    },
    "action":"freeform\/submit"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26