GraphQL 3.10.0+

Freeform supports querying form layouts via GraphQL. This guide assumes you have some GraphQL experience. To learn more about GraphQL and Craft, please check out the Fetch content with GraphQL guide.

GraphQL

Querying Freeform data

Freeform has a root freeform query, which contains all the possible queries nested inside it to avoid conflicts with other plugins.

Querying multiple Forms

To query all or some forms, you have to use the forms query:



 


















query {
  freeform {
    forms {
      name
      handle
      pages {
        label
        rows {
          fields {
            id
            type
            label
            handle
            required
          }
        }
      }
    }
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20

Example response data:

{
  "data": {
    "freeform": {
      "forms": [
        {
          "name": "My Form",
          "handle": "myForm",
          "pages": [
            {
              "label": "First Page",
              "rows": [
                {
                  "fields": [
                    {
                      "type": "text",
                      "label": "First Name",
                      "handle": "firstName",
                      "required": false
                    },
                    {
                      "type": "text",
                      "label": "Last Name",
                      "handle": "lastName",
                      "required": true
                    }
                  ]
                },
                {
                  "fields": [
                    {
                      "type": "submit",
                      "label": "Submit",
                      "handle": null,
                      "required": false
                    }
                  ]
                }
              ]
            }
          ]
        }
      ]
    }
  }
}
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
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

Querying a single Form

You can query a single form directly by using the form query:



 









query {
  freeform {
    form (handle: "my-form") {
      name
      handle
      pages {
        # ...
      }
    }
  }
}
1
2
3
4
5
6
7
8
9
10
11

Example response data:

{
  "data": {
    "freeform": {
      "form": {
        "name": "My Form",
        "handle": "myForm",
        "pages": [
          {
            "label": "First Page",
            "rows": [
              {
                "fields": [
                  {
                    "type": "text",
                    "label": "First name",
                    "handle": "firstName",
                    "required": false
                  }
                ]
              }
            ]
          }
        ]
      }
    }
  }
}
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
27

Form Query Arguments

The following arguments are available when querying single or multiple forms:

Argument Type Description
id [int] Narrow the queried forms by one or more form ID's
uid [string] Narrow the queried forms by one or more form UID's
handle [string] Narrow the queried forms by one or more form handles
limit int Limit the amount of returned form results
offset int Offset the returned form results
orderBy string Order the forms by a specific property
sort string Sort by asc or desc order
query {
  freeform {
    # This is just an example
    # For `id`, `uid` and `handle` - you can either pass a single value 
    # or an array of values for each argument
    form (id: 1, handle: "test", limit: 1, offset: 2, orderBy: "name", sort: "desc") {
      id
    }
  }
}
1
2
3
4
5
6
7
8
9
10

Field Query Arguments

You can query fields by the following arguments:

Argument Type Description
id [int] Narrow the queried fields by one or more field's ID's
hash [string] Narrow the queried fields by one or more field's UID's
handle [string] Narrow the queried fields by one or more field's handles
query {
  freeform {
    forms {
      # This is just an example
      # You can either pass a single value or an array of values for each argument
      fields (id: [1, 2, 3], handle: ["firstName", "lastName"], hash: "some-hash") {
        id
        handle
        hash
      }
    }
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13

Form Interface

These are the fields available for the FormInterface:

Field Type Description
id int ID
uid string UID
name string Name
handle string Handle
hash string The form's hash needed to submit forms
color string Color
description string Description
returnUrl string The specified return URL
storeData boolean Are submissions being stored for this form
submissionTitleFormat string Title format used for new submission titles
extraPostUrl string An URL that will get a POST call with the submitted data
extraPostTriggerPhrase string A keyword or phrase Freeform should check for in the output of the POST URL to know if and when there’s an error to log, e.g. ‘error’ or ‘an error occurred’.
ipCollectingEnabled boolean Are the IP addresses being stored
ajaxEnabled boolean Is the ajax enabled for this form
showSpinner boolean Should the submit button show a spinner when submitting
showLoadingText boolean Should the submit button change the button label while submitting
loadingText string The submit button loading label text
recaptchaEnabled boolean Should reCAPTCHA be enabled for this form
defaultStatus int The assigned default status ID of new submissions
formTemplate string The assigned default formatting template
gtmEnabled boolean Is the Google Tag Manager enabled for this form?
gtmId string The Google Tag Manager ID
gtmEventName string The name of the Event that will be added to Google Tag Manager's data layer
honeypot HoneypotInterface A fresh honeypot instance
csrfToken CsrfTokenInterface A fresh csrf token
fields [FieldInterface] A list of Form's Field
pages [PageInterface] A list of Form's Page entities

Field Interface

The base FieldInterface implemented by all field types. You can see specific Field Type fields here.

Field Type Description
id int ID
type string Type
label string Label
hash string Genrated unique field hash
handle string Handle
instruction string Instructions
required boolean Is the field required
pageIndex int The page index this field is assigned to
inputAttributes [KeyValueMapInterface] Field's input attributes
labelAttributes [KeyValueMapInterface] Field's label attributes
errorAttributes [KeyValueMapInterface] Field's error attributes
instructionAttributes [KeyValueMapInterface] Field's instruction attributes

Page Interaface

Each page contains a list of RowInterface objects:

Field Type Description
index int Index of the page
label string Page's label
rows [RowInterface] A list of RowInterface objects

Row Interaface

Each row contains a list of fields:

Field Type Description
id string A unique hash generated for each row
fields [FieldInterface] A list of FieldInterface objects

Field Types

Here's a list of all Field Types and their specific fields:

Text

Field Type Description
value string The default value
maxLength int Maximum length of chars allowed for this field
placeholder string Input's placeholder attribute
fields {
  ... on FreeformField_Text {
    value
    maxLength
    placeholder
  }
}
1
2
3
4
5
6
7

Textarea

Field Type Description
value string The default value
maxLength int Maximum length of chars allowed for this field
rows int Number of rows shown for this textarea
placeholder string Input's placeholder attribute
fields {
  ... on FreeformField_Textarea {
    value
    maxLength
    rows
    placeholder
  }
}
1
2
3
4
5
6
7
8

Select

Field Type Description
value string The default value
options [OptionInterface] The assigned options
fields {
  ... on FreeformField_Select {
    value
    options {
      value
      label
      checked
    }
  }
}
1
2
3
4
5
6
7
8
9
10

Checkbox

Field Type Description
value string The default value
checked boolean Should the checkbox be checked by default
fields {
  ... on FreeformField_Checkbox {
    value
    checked
  }
}
1
2
3
4
5
6

Multi-Select

Field Type Description
values [string] The default values
options [OptionInterface] The assigned options
fields {
  ... on FreeformField_MultipleSelect {
    values
    options {
      value
      label
      checked
    }
  }
}
1
2
3
4
5
6
7
8
9
10

Checkbox Group

Field Type Description
values [string] The default values
oneLine boolean Should this be shown in a single line
options [OptionInterface] The assigned options
fields {
  ... on FreeformField_CheckboxGroup {
    values
    oneLine
    options {
      value
      label
      checked
    }
  }
}
1
2
3
4
5
6
7
8
9
10
11

Radio Group

Field Type Description
value string The default value
options [OptionInterface] The assigned options
fields {
  ... on FreeformField_RadioGroup {
    value
    options {
      value
      label
      checked
    }
  }
}
1
2
3
4
5
6
7
8
9
10

Email

Field Type Description
notificationId string The ID or the filename of the email template
placeholder string Input's placeholder attribute
fields {
  ... on FreeformField_Email {
    notificationId
    placeholder
  }
}
1
2
3
4
5
6

Dynamic Recipients

Field Type Description
values [string] The default values
notificationId string The ID or the filename of the email template
showAsRadio boolean Should the field be shown as a list of radio inputs
showAsCheckboxes boolean Should the field be shown as a list of checkbox inputs
oneLine boolean Should radios or checkboxes be displayed in a single line
options [OptionInterface] The assigned options
fields {
  ... on FreeformField_DynamicRecipients {
    values
    notificationId
    showAsRadio
    showAsCheckboxes
    oneLine
    options {
      valuel
      label
      checked
    }
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14

Number

Field Type Description
value string The default value
minLength int Minimum length of the number
minValue int Minimum value of the number
maxValue int Maximum length of the number
decimalCount int Number of decimals
decimalSeparator string The decimal separator
thousandsSeparator string The thousands separator
allowNegative bool Allow negative numbers
placeholder string Input's placeholder attribute
fields {
  ... on FreeformField_Number {
    value
    minLength
    minValue
    maxValue
    decimalCount
    decimalSeparator
    thousandsSeparator
    allowNegative
    placeholder
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13

File

Field Type Description
fileKinds [string] Allowed file kinds
maxFileSizeKB int Maximum allowed filesize in KB
fileCount int Number of allowed simultaneous file uploads
fields {
  ... on FreeformField_File {
    fileKinds
    maxFileSizeKB
    fileCount
  }
}
1
2
3
4
5
6
7

Confirmation

Field Type Description
targetFieldHash string Hash of the field that has to be confirmed
fields {
  ... on FreeformField_Confirmation {
    targetFieldHash
  }
}
1
2
3
4
5

Date & Time

Field Type Description
value string The default value
dateTimeType string Type of the date field. ("date", "time", "both")
generatePlaceholder boolean Should a placeholder be auto-generated for this field
dateOrder string Order of the date chunks.
date4DigitYear boolean Determines if the year should be displayed with 4 digits or two
dateLeadingZero boolean Determines if the dates should use a leading zero
dateSeparator string Date separator
clock24h boolean Should the clock use a 24h format
clockSeparator string Clock separator
clockAMPMSeparate boolean Should the AM/PM be separated from the time by a space
useDatepicker boolean Should the built-in datepicker be used
minDate string Specifies the minimum allowed date that can be picked
maxDate string Specifies the maximum allowed date that can be picked
fields {
  ... on FreeformField_Datetime {
    value
    dateTimeType
    generatePlaceholder
    dateOrder
    date4DigitYear
    dateLeadingZero
    dateSeparator
    clock24h
    clockSeparator
    clockAMPMSeparate
    useDatepicker
    minDate
    maxDate
  }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

Opinion Scale

Field Type Description
value string The default value
legends [string] A list of all the assigned Legends
scales [ScalesInterface] The assigned Scales
fields {
  ... on FreeformField_OpinionScale {
    value
    legends
    scales {
      value
      label
    }
  }
}
1
2
3
4
5
6
7
8
9
10

Phone

Field Type Description
value string The default value
pattern string Phone number pattern
useJsMask boolean Should the built-in pattern matcher javascript be enabled
fields {
  ... on FreeformField_Phone {
    value
    pattern
    useJsMask
  }
}
1
2
3
4
5
6
7

Rating

Field Type Description
value string The default value
maxValue int Phone number pattern
colorIdle string Color of the unselected, unhovered rating star
colorHover string Color of the hovered rating star
colorSelected string Color of the selected rating star
fields {
  ... on FreeformField_Rating {
    value
    maxValue
    colorIdle
    colorHover
    colorSelected
  }
}
1
2
3
4
5
6
7
8
9

Regex

Field Type Description
value string The default value
pattern string Regex pattern
message string The error message to be displayed
fields {
  ... on FreeformField_Regex {
    value
    pattern
    message
  }
}
1
2
3
4
5
6
7

Signature

Field Type Description
width int Width in pixels
height int Height in pixels
showClearButton boolean Determines if the "clear" button should be displayed
borderColor string Signature field border color
backgroundColor string Signature field background color
penColor string Signature field pen color
penDotSize float The size of the pen dot
fields {
  ... on FreeformField_Signature {
    width
    height
    showClearButton
    borderColor
    backgroundColor
    penColor
    penDotSize
  }
}
1
2
3
4
5
6
7
8
9
10
11

Table

Field Type Description
useScript boolean Should the built-in javascript for handling table rows be used
maxRows int Number of maximum allowed rows this table can have
addButtonLabel boolean The label for the "add row" button
addButtonMarkup string Custom html for the "add row" button
removeButtonLabel string The label for the "delete row" button
removeButtonMarkup string Custom html for the "delete row" button
tableLayout string JSON of the table layout
fields {
  ... on FreeformField_Table {
    useScript
    maxRows
    addButtonLabel
    addButtonMarkup
    removeButtonLabel
    removeButtonMarkup
    tableLayout
  }
}
1
2
3
4
5
6
7
8
9
10
11

Mailing List

Field Type Description
hidden boolean Should this field be a hidden field or a checkbox
fields {
  ... on FreeformField_MailingList {
    hidden
  }
}
1
2
3
4
5

Submit

Field Type Description
labelNext string Label for the "next" button
labelPrev string Label for the "previous" button
disablePrev boolean Is the "previous" button disabled
position string Position of the buttons
fields {
  ... on FreeformField_Submit {
    labelNext
    labelPrev
    disablePrev
    position
  }
}
1
2
3
4
5
6
7
8

Additional Interfaces

Option Interface

Field Type Description
value string Option's value
label string Option's label
checked boolean Is the option checked

KeyValueMap Interface

Field Type Description
key string Key name
value string Value

Scales Interface

Field Type Description
value string Value
label string Label

Honeypot Interface

Field Type Description
name string Value
hash string Hash
timestamp int Timestamp of the creation date

CSRF Token Interface

Field Type Description
name string Name of the CSRF token
value string Value of the CSRF token
Last Updated: 1/5/2021, 10:23:52 AM