Get a reusable form definition
curl --request GET \
--url https://api.batchrelay.com/v1/studios/{studio_id}/form-definitions/{form_definition_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.batchrelay.com/v1/studios/{studio_id}/form-definitions/{form_definition_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.batchrelay.com/v1/studios/{studio_id}/form-definitions/{form_definition_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.batchrelay.com/v1/studios/{studio_id}/form-definitions/{form_definition_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.batchrelay.com/v1/studios/{studio_id}/form-definitions/{form_definition_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.batchrelay.com/v1/studios/{studio_id}/form-definitions/{form_definition_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.batchrelay.com/v1/studios/{studio_id}/form-definitions/{form_definition_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"fields": [
{
"input_type": "text",
"key": "<string>",
"label": "<string>",
"required": true,
"sort_order": 1,
"allow_multiple": true,
"boolean_display": "toggle",
"description": "<string>",
"option_ids": [
"<string>"
],
"options": [
"<string>"
],
"options_display": "dropdown",
"placeholder": "<string>",
"semantic_key": "<string>",
"semantic_label": "<string>",
"show_when": {
"field_key": "<string>",
"operator": "is_one_of",
"option_ids": [
"<string>"
]
}
}
],
"id": "<string>",
"name": "<string>",
"studio_id": "<string>",
"description": "<string>",
"form_presentation": {
"pages": [
{
"id": "<string>",
"rows": [
{
"fields": [
{
"field_key": "<string>",
"width": "full"
}
],
"id": "<string>"
}
],
"title": "<string>",
"description": "<string>"
}
],
"public_title": "<string>",
"description": "<string>"
},
"form_spec": {
"fields": [
{
"input_type": "text",
"key": "<string>",
"label": "<string>",
"required": true,
"sort_order": 1,
"allow_multiple": true,
"boolean_display": "toggle",
"description": "<string>",
"options": [
{
"id": "<string>",
"label": "<string>"
}
],
"options_display": "dropdown",
"placeholder": "<string>",
"semantic_key": "<string>",
"show_when": {
"field_key": "<string>",
"operator": "is_one_of",
"option_ids": [
"<string>"
]
}
}
],
"name": "<string>",
"spec_version": 2,
"form_presentation": {
"pages": [
{
"id": "<string>",
"rows": [
{
"fields": [
{
"field_key": "<string>",
"width": "full"
}
],
"id": "<string>"
}
],
"title": "<string>",
"description": "<string>"
}
],
"public_title": "<string>",
"description": "<string>"
}
}
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}Authorizations
Batch Relay scoped API key or an anonymous Test Mode session. Scope names document required capabilities. Anonymous sessions are sandbox-only and do not authorize studio, event, billing, or Live Mode operations.
Headers
Untrusted optional analytics hint naming the calling client surface. It never affects authorization, routing, pricing, or behavior.
1 - 100Untrusted optional analytics hint naming the calling client version. It never affects authorization, routing, pricing, or behavior.
1 - 100Untrusted optional analytics hint naming the invocation mode. It never affects authorization, routing, pricing, or behavior.
1 - 100Path Parameters
Stable public studio ID beginning with stu_. The API never selects a studio implicitly; a local CLI profile name is not a studio ID.
5 - 256^stu_[A-Za-z0-9_-]+$1 - 256Response
Reusable definition including fields and presentation
200Show child attributes
Show child attributes
Stable public form-definition ID.
111Typed public form layout. It intentionally excludes heroStorageId, Convex IDs, athlete data, guardian data, and submitted answers.
Show child attributes
Show child attributes
Versioned form definition with persistent option IDs. On writes, mutually exclusive with fields and form_presentation. Legacy revisions may omit this until their choices have IDs.
Show child attributes
Show child attributes
curl --request GET \
--url https://api.batchrelay.com/v1/studios/{studio_id}/form-definitions/{form_definition_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.batchrelay.com/v1/studios/{studio_id}/form-definitions/{form_definition_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.batchrelay.com/v1/studios/{studio_id}/form-definitions/{form_definition_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.batchrelay.com/v1/studios/{studio_id}/form-definitions/{form_definition_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.batchrelay.com/v1/studios/{studio_id}/form-definitions/{form_definition_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.batchrelay.com/v1/studios/{studio_id}/form-definitions/{form_definition_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.batchrelay.com/v1/studios/{studio_id}/form-definitions/{form_definition_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"fields": [
{
"input_type": "text",
"key": "<string>",
"label": "<string>",
"required": true,
"sort_order": 1,
"allow_multiple": true,
"boolean_display": "toggle",
"description": "<string>",
"option_ids": [
"<string>"
],
"options": [
"<string>"
],
"options_display": "dropdown",
"placeholder": "<string>",
"semantic_key": "<string>",
"semantic_label": "<string>",
"show_when": {
"field_key": "<string>",
"operator": "is_one_of",
"option_ids": [
"<string>"
]
}
}
],
"id": "<string>",
"name": "<string>",
"studio_id": "<string>",
"description": "<string>",
"form_presentation": {
"pages": [
{
"id": "<string>",
"rows": [
{
"fields": [
{
"field_key": "<string>",
"width": "full"
}
],
"id": "<string>"
}
],
"title": "<string>",
"description": "<string>"
}
],
"public_title": "<string>",
"description": "<string>"
},
"form_spec": {
"fields": [
{
"input_type": "text",
"key": "<string>",
"label": "<string>",
"required": true,
"sort_order": 1,
"allow_multiple": true,
"boolean_display": "toggle",
"description": "<string>",
"options": [
{
"id": "<string>",
"label": "<string>"
}
],
"options_display": "dropdown",
"placeholder": "<string>",
"semantic_key": "<string>",
"show_when": {
"field_key": "<string>",
"operator": "is_one_of",
"option_ids": [
"<string>"
]
}
}
],
"name": "<string>",
"spec_version": 2,
"form_presentation": {
"pages": [
{
"id": "<string>",
"rows": [
{
"fields": [
{
"field_key": "<string>",
"width": "full"
}
],
"id": "<string>"
}
],
"title": "<string>",
"description": "<string>"
}
],
"public_title": "<string>",
"description": "<string>"
}
}
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}{
"code": "<string>",
"docs_url": "<string>",
"error": "<string>",
"message": "<string>",
"request_id": "<string>"
}