Get form

This query allows us to fetch the details and questions for a specific form and can be used to render the form and its questions in your UI.

Evaluating display logic

A form may have questions that are conditionally shown/hidden based on previous answers in the form, which can be referred to as question visibility logic. In order to ensure you're always showing the right set of questions, you have 2 options:

1. Implement the logic yourself to evaluate the display logic and show/hide questions based on the answers given in a form. You can find the display logic under the rule field.
2. Use the evaluateFormRules mutation and just send us the intermediary responses on the questions and we'll let you know what questions need to be shown/hidden. Click here for more information on this mutation.

Metadata

Form and question metadata is returned in all form queries as a JSON string rather than a JSON object. This is because the metadata is defined in Studio as a JSON string and we want to avoid any potential parsing errors. You can parse the metadata string into a JSON object in your application (for example, using JSON.parse in JavaScript/TypeScript, json.loads in Python or json_decode in PHP or Ruby).

Request

Query

graphql
Copy
01query GetForm($id: String!) {
02  form(id: $id) {
03    form {
04      id
05      definition_id # static id from Studio
06      title
07      key # form key set in Studio
08      metadata # JSON metadata string set in Studio
09      questions {
10        id
11        definition_id # static id from Studio
12        title # string or html string (for description questions)
13        key # question key set in Studio
14        dataPointValueType
15        questionType
16        metadata # JSON metadata string set in Studio
17        options {
18          id
19          value
20          label
21        }
22        rule {
23          # visibility conditions of a question
24          boolean_operator
25          conditions {
26            id
27            reference # definition id of the question this condition is based on
28            operator
29            operand {
30              type
31              value
32            }
33          }
34        }
35      }
36    }
37  }
38}

Variables

json
Copy
01{
02  "id": "{{FORM_ID}}"
03}

Where to find the form id

The id of the form can be found in the object.id field of an activity.

json
Copy
01{
02  "activity": {
03    "id": "{{ACTIVITY_ID}}",
04    "object": {
05      "id": "{{FORM_ID}}",
06      "type": "form"
07    },
08    ...
09  }
10}

How to use