Guides
You can query the GraphQL API to get field definitions for a form.
Using a GraphQL query you can get the current published version of an app's schema. The data you'll find will include the app id, formKeys, and labels.
You'll need the id of the form's app in order to get it's schema.
query {
apps {
id
name
}
}
curl 'https://subdomain.kualibuild.com/app/api/v0/graphql' -H 'Content-Type: application/json' -H 'Authorization: Bearer apikey' --data-binary '{"query":"query { apps { id name }}","variables":{}}' --compressed
import fetch from 'node-fetch'
const subdomain = 'subdomain'
const apikey = 'apikey'
const query = `query {
apps {
id
name
}
}`
const variables = {}
fetch(`https://${subdomain}.kualibuild.com/app/api/v0/graphql`, {
method:'POST',
headers: {
'Content-Type': 'application/json',
Authorization: `Bearer ${apikey}`
},
body: JSON.stringify({query, variables})
})
.then(res => res.text())
.then(data => console.log(data))
.catch(err => console.log(err))
<?php
$subdomain = "subdomain";
$apikey = "apikey";
$url = "https://{$subdomain}.kualibuild.com/app/api/v0/graphql";
$curl = curl_init($url);
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$headers = array(
"Content-Type: application/json",
"Authorization: Bearer {$apikey}",
);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
$data= '{"query":"query { apps { id name }}","variables":{}}';
curl_setopt($curl, CURLOPT_POSTFIELDS, $data);
//for debug only!
curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, false);
curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
$resp = curl_exec($curl);
curl_close($curl);
var_dump($resp);
require 'net/http'
require 'uri'
require 'json'
subdomain = "subdomain"
apikey = "apikey"
uri = URI.parse("https://#{subdomain}.kualibuild.com/app/api/v0/graphql")
request = Net::HTTP::Post.new(uri)
request.content_type = "application/json"
request["Authorization"] = "Bearer #{apikey}"
request.body = JSON.dump({
"query" => "query {
apps {
id
name
}
}",
"variables" => {}
})
req_options = {
use_ssl: uri.scheme == "https",
}
response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
http.request(request)
end
puts response.code
puts response.body
import java.io.*;
import java.util.*;
import java.net.HttpURLConnection;
import java.net.URL;
import java.nio.charset.Charset;
public class exampleCreate {
public static void main(String[] args) throws IOException {
String subdomain = "subdomain";
String apikey = "apikey";
URL url = new URL("https://" + subdomain + ".kualibuild.com/app/api/v0/graphql");
HttpURLConnection http = (HttpURLConnection)url.openConnection();
http.setRequestMethod("POST");
http.setDoOutput(true);
http.setRequestProperty("Content-Type", "application/json");
http.setRequestProperty("Origin", "https://" + subdomain + ".kualibuild.com");
http.setRequestProperty("Authorization", "Bearer " + apikey);
String data = "{\"query\":\"query { apps { id name }}\",\"variables\":{}}";
byte[] out = data.getBytes(Charset.forName("UTF-8"));
OutputStream stream = http.getOutputStream();
stream.write(out);
System.out.println(http.getResponseCode() + " " + http.getResponseMessage());
BufferedReader in = new BufferedReader(new InputStreamReader(http.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
//print in String
System.out.println(response.toString());
http.disconnect();
}
}
{
"data": {
"apps": [
{
"id": "5d5f337395a039001e48a649",
"name": "Incomplete Grade Request"
},
{
"id": "5ac835643d7f3600196b2749",
"name": "Parking Tag Application"
},
{
"id": "5e6715e208f295001f8219b6",
"name": "Travel Disclosure"
},
]
}
}
Note how the formKey attribute provides the unique identifier for each field. The label attribute is the label that appears on the form for that field.
query ($id: ID) {
app(id: $id) {
id
formVersion {
schema {
formKey
label
}
}
}
}
curl 'https://subdomain.kualibuild.com/app/api/v0/graphql' -H 'Content-Type: application/json' -H 'Authorization: Bearer apikey' --data-binary '{"query":"query ($id: ID) { app(id: $id) { id formVersion { schema { formKey label } } }}","variables":{"id":"5ac835643d7f3600196b2749"}}' --compressed
import fetch from 'node-fetch'
const subdomain = 'subdomain'
const apikey = 'apikey'
const query = `query ($id: ID) {
app(id: $id) {
id
formVersion {
schema {
formKey
label
}
}
}
}`
const variables = {"id":"5ac835643d7f3600196b2749"}
fetch(`https://${subdomain}.kualibuild.com/app/api/v0/graphql`, {
method:'POST',
headers: {
'Content-Type': 'application/json',
Authorization: `Bearer ${apikey}`
},
body: JSON.stringify({query, variables})
})
.then(res => res.text())
.then(data => console.log(data))
.catch(err => console.log(err))
<?php
$subdomain = "subdomain";
$apikey = "apikey";
$url = "https://{$subdomain}.kualibuild.com/app/api/v0/graphql";
$curl = curl_init($url);
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_POST, true);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
$headers = array(
"Content-Type: application/json",
"Authorization: Bearer {$apikey}",
);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
$data= '{"query":"query ($id: ID) { app(id: $id) { id formVersion { schema { formKey label } } }}","variables":{"id":"5ac835643d7f3600196b2749"}}';
curl_setopt($curl, CURLOPT_POSTFIELDS, $data);
//for debug only!
curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, false);
curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
$resp = curl_exec($curl);
curl_close($curl);
var_dump($resp);
require 'net/http'
require 'uri'
require 'json'
subdomain = "subdomain"
apikey = "apikey"
uri = URI.parse("https://#{subdomain}.kualibuild.com/app/api/v0/graphql")
request = Net::HTTP::Post.new(uri)
request.content_type = "application/json"
request["Authorization"] = "Bearer #{apikey}"
request.body = JSON.dump({
"query" => "query ($id: ID) {
app(id: $id) {
id
formVersion {
schema {
formKey
label
}
}
}
}",
"variables" => {"id":"5ac835643d7f3600196b2749"}
})
req_options = {
use_ssl: uri.scheme == "https",
}
response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
http.request(request)
end
puts response.code
puts response.body
import java.io.*;
import java.util.*;
import java.net.HttpURLConnection;
import java.net.URL;
import java.nio.charset.Charset;
public class exampleCreate {
public static void main(String[] args) throws IOException {
String subdomain = "subdomain";
String apikey = "apikey";
URL url = new URL("https://" + subdomain + ".kualibuild.com/app/api/v0/graphql");
HttpURLConnection http = (HttpURLConnection)url.openConnection();
http.setRequestMethod("POST");
http.setDoOutput(true);
http.setRequestProperty("Content-Type", "application/json");
http.setRequestProperty("Origin", "https://" + subdomain + ".kualibuild.com");
http.setRequestProperty("Authorization", "Bearer " + apikey);
String data = "{\"query\":\"query ($id: ID) { app(id: $id) { id formVersion { schema { formKey label } } }}\",\"variables\":{\"id\":\"5ac835643d7f3600196b2749\"}}";
byte[] out = data.getBytes(Charset.forName("UTF-8"));
OutputStream stream = http.getOutputStream();
stream.write(out);
System.out.println(http.getResponseCode() + " " + http.getResponseMessage());
BufferedReader in = new BufferedReader(new InputStreamReader(http.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
response.append(inputLine);
}
in.close();
//print in String
System.out.println(response.toString());
http.disconnect();
}
}
{"id":"5ac835643d7f3600196b2749"}
{
"data": {
"app": {
"id": "5ac835643d7f3600196b2749",
"formVersion": {
"schema": [
{
"formKey": "data.2JzrEICFX1",
"label": "Name"
},
{
"formKey": "data.RmAnxiNTnj",
"label": "Vehicle Make"
},
{
"formKey": "data.ib_QUsLdUO",
"label": "Vehicle Model"
},
{
"formKey": "data.nYMA37CRlj",
"label": "Vehicle Color"
},
{
"formKey": "data.FgdlaBSgn-",
"label": "License Plate"
},
{
"formKey": "meta.submittedBy",
"label": "Submitter"
},
{
"formKey": "meta.submittedBy.id",
"label": "Submitter - ID"
},
{
"formKey": "meta.submittedBy.displayName",
"label": "Submitter - Display Name"
},
{
"formKey": "meta.submittedBy.schoolId",
"label": "Submitter - School ID"
},
{
"formKey": "meta.submittedBy.email",
"label": "Submitter - Email"
},
{
"formKey": "meta.submittedBy.username",
"label": "Submitter - Username"
},
{
"formKey": "meta.submittedAt",
"label": "Submitted At"
},
{
"formKey": "meta.createdBy",
"label": "Created By"
},
{
"formKey": "meta.createdBy.id",
"label": "Created By - ID"
},
{
"formKey": "meta.createdBy.displayName",
"label": "Created By - Display Name"
},
{
"formKey": "meta.createdBy.schoolId",
"label": "Created By - School ID"
},
{
"formKey": "meta.createdBy.email",
"label": "Created By - Email"
},
{
"formKey": "meta.createdBy.username",
"label": "Created By - Username"
},
{
"formKey": "meta.createdAt",
"label": "Created At"
},
{
"formKey": "meta.serialNumber",
"label": "Number"
},
{
"formKey": "meta.link",
"label": "Link to Document"
},
{
"formKey": "meta.workflowTotalRuntime",
"label": "Workflow Total Run Time"
},
{
"formKey": "meta.workflowStatus",
"label": "Workflow Status"
},
{
"formKey": "meta.currentWorkflowSteps",
"label": "Time on Current Step"
}
]
}
}
}
}