Create a form field
curl --request POST \
--url https://app.orgo.space/api/v1/form_fields \
--header 'Api-Token: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"form": "/api/v1/forms/1",
"customField": {
"tenant": "/api/v1/tenants/1",
"name": "Boston Chapter",
"fieldType": "string",
"fieldOptions": [
"string"
],
"position": 42,
"conditionedField": "/api/v1/custom_fields/1",
"conditionedValue": "string",
"isOnlyAdmin": true,
"visibility": "string",
"isEncrypted": true,
"discriminator": "string",
"fileConfig": [
"string"
],
"exampleMedia": {
"size": 42,
"contentUrl": "https://civic-collective.example.com",
"type": "MEMBER",
"mimeType": "application/pdf"
}
},
"position": 42,
"description": "Quarterly chapter meeting open to all members.",
"isMandatory": true
}
'import requests
url = "https://app.orgo.space/api/v1/form_fields"
payload = {
"form": "/api/v1/forms/1",
"customField": {
"tenant": "/api/v1/tenants/1",
"name": "Boston Chapter",
"fieldType": "string",
"fieldOptions": ["string"],
"position": 42,
"conditionedField": "/api/v1/custom_fields/1",
"conditionedValue": "string",
"isOnlyAdmin": True,
"visibility": "string",
"isEncrypted": True,
"discriminator": "string",
"fileConfig": ["string"],
"exampleMedia": {
"size": 42,
"contentUrl": "https://civic-collective.example.com",
"type": "MEMBER",
"mimeType": "application/pdf"
}
},
"position": 42,
"description": "Quarterly chapter meeting open to all members.",
"isMandatory": True
}
headers = {
"Api-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Api-Token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
form: '/api/v1/forms/1',
customField: {
tenant: '/api/v1/tenants/1',
name: 'Boston Chapter',
fieldType: 'string',
fieldOptions: ['string'],
position: 42,
conditionedField: '/api/v1/custom_fields/1',
conditionedValue: 'string',
isOnlyAdmin: true,
visibility: 'string',
isEncrypted: true,
discriminator: 'string',
fileConfig: ['string'],
exampleMedia: {
size: 42,
contentUrl: 'https://civic-collective.example.com',
type: 'MEMBER',
mimeType: 'application/pdf'
}
},
position: 42,
description: 'Quarterly chapter meeting open to all members.',
isMandatory: true
})
};
fetch('https://app.orgo.space/api/v1/form_fields', 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://app.orgo.space/api/v1/form_fields",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'form' => '/api/v1/forms/1',
'customField' => [
'tenant' => '/api/v1/tenants/1',
'name' => 'Boston Chapter',
'fieldType' => 'string',
'fieldOptions' => [
'string'
],
'position' => 42,
'conditionedField' => '/api/v1/custom_fields/1',
'conditionedValue' => 'string',
'isOnlyAdmin' => true,
'visibility' => 'string',
'isEncrypted' => true,
'discriminator' => 'string',
'fileConfig' => [
'string'
],
'exampleMedia' => [
'size' => 42,
'contentUrl' => 'https://civic-collective.example.com',
'type' => 'MEMBER',
'mimeType' => 'application/pdf'
]
],
'position' => 42,
'description' => 'Quarterly chapter meeting open to all members.',
'isMandatory' => true
]),
CURLOPT_HTTPHEADER => [
"Api-Token: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.orgo.space/api/v1/form_fields"
payload := strings.NewReader("{\n \"form\": \"/api/v1/forms/1\",\n \"customField\": {\n \"tenant\": \"/api/v1/tenants/1\",\n \"name\": \"Boston Chapter\",\n \"fieldType\": \"string\",\n \"fieldOptions\": [\n \"string\"\n ],\n \"position\": 42,\n \"conditionedField\": \"/api/v1/custom_fields/1\",\n \"conditionedValue\": \"string\",\n \"isOnlyAdmin\": true,\n \"visibility\": \"string\",\n \"isEncrypted\": true,\n \"discriminator\": \"string\",\n \"fileConfig\": [\n \"string\"\n ],\n \"exampleMedia\": {\n \"size\": 42,\n \"contentUrl\": \"https://civic-collective.example.com\",\n \"type\": \"MEMBER\",\n \"mimeType\": \"application/pdf\"\n }\n },\n \"position\": 42,\n \"description\": \"Quarterly chapter meeting open to all members.\",\n \"isMandatory\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Api-Token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.orgo.space/api/v1/form_fields")
.header("Api-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"form\": \"/api/v1/forms/1\",\n \"customField\": {\n \"tenant\": \"/api/v1/tenants/1\",\n \"name\": \"Boston Chapter\",\n \"fieldType\": \"string\",\n \"fieldOptions\": [\n \"string\"\n ],\n \"position\": 42,\n \"conditionedField\": \"/api/v1/custom_fields/1\",\n \"conditionedValue\": \"string\",\n \"isOnlyAdmin\": true,\n \"visibility\": \"string\",\n \"isEncrypted\": true,\n \"discriminator\": \"string\",\n \"fileConfig\": [\n \"string\"\n ],\n \"exampleMedia\": {\n \"size\": 42,\n \"contentUrl\": \"https://civic-collective.example.com\",\n \"type\": \"MEMBER\",\n \"mimeType\": \"application/pdf\"\n }\n },\n \"position\": 42,\n \"description\": \"Quarterly chapter meeting open to all members.\",\n \"isMandatory\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.orgo.space/api/v1/form_fields")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Api-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"form\": \"/api/v1/forms/1\",\n \"customField\": {\n \"tenant\": \"/api/v1/tenants/1\",\n \"name\": \"Boston Chapter\",\n \"fieldType\": \"string\",\n \"fieldOptions\": [\n \"string\"\n ],\n \"position\": 42,\n \"conditionedField\": \"/api/v1/custom_fields/1\",\n \"conditionedValue\": \"string\",\n \"isOnlyAdmin\": true,\n \"visibility\": \"string\",\n \"isEncrypted\": true,\n \"discriminator\": \"string\",\n \"fileConfig\": [\n \"string\"\n ],\n \"exampleMedia\": {\n \"size\": 42,\n \"contentUrl\": \"https://civic-collective.example.com\",\n \"type\": \"MEMBER\",\n \"mimeType\": \"application/pdf\"\n }\n },\n \"position\": 42,\n \"description\": \"Quarterly chapter meeting open to all members.\",\n \"isMandatory\": true\n}"
response = http.request(request)
puts response.read_body{
"id": 42,
"form": "/api/v1/forms/1",
"customField": {
"id": 42,
"tenant": "/api/v1/tenants/1",
"name": "Boston Chapter",
"fieldType": "string",
"fieldOptions": [
"string"
],
"position": 42,
"conditionedField": "/api/v1/custom_fields/1",
"conditionedValue": "string",
"isOnlyAdmin": true,
"visibility": "string",
"isEncrypted": true,
"discriminator": "string",
"fileConfig": [
"string"
],
"exampleMedia": {
"id": 42,
"size": 42,
"contentUrl": "https://civic-collective.example.com",
"type": "MEMBER",
"mimeType": "application/pdf",
"originalName": "Boston Chapter"
}
},
"position": 42,
"description": "Quarterly chapter meeting open to all members.",
"isMandatory": true
}FormField
Create a form field
Creates a new form field linked to a form. Each form field wraps a custom field definition that specifies the field type (input, dropdown, radio, checkboxes, etc.) and options.
POST
/
api
/
v1
/
form_fields
Create a form field
curl --request POST \
--url https://app.orgo.space/api/v1/form_fields \
--header 'Api-Token: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"form": "/api/v1/forms/1",
"customField": {
"tenant": "/api/v1/tenants/1",
"name": "Boston Chapter",
"fieldType": "string",
"fieldOptions": [
"string"
],
"position": 42,
"conditionedField": "/api/v1/custom_fields/1",
"conditionedValue": "string",
"isOnlyAdmin": true,
"visibility": "string",
"isEncrypted": true,
"discriminator": "string",
"fileConfig": [
"string"
],
"exampleMedia": {
"size": 42,
"contentUrl": "https://civic-collective.example.com",
"type": "MEMBER",
"mimeType": "application/pdf"
}
},
"position": 42,
"description": "Quarterly chapter meeting open to all members.",
"isMandatory": true
}
'import requests
url = "https://app.orgo.space/api/v1/form_fields"
payload = {
"form": "/api/v1/forms/1",
"customField": {
"tenant": "/api/v1/tenants/1",
"name": "Boston Chapter",
"fieldType": "string",
"fieldOptions": ["string"],
"position": 42,
"conditionedField": "/api/v1/custom_fields/1",
"conditionedValue": "string",
"isOnlyAdmin": True,
"visibility": "string",
"isEncrypted": True,
"discriminator": "string",
"fileConfig": ["string"],
"exampleMedia": {
"size": 42,
"contentUrl": "https://civic-collective.example.com",
"type": "MEMBER",
"mimeType": "application/pdf"
}
},
"position": 42,
"description": "Quarterly chapter meeting open to all members.",
"isMandatory": True
}
headers = {
"Api-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Api-Token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
form: '/api/v1/forms/1',
customField: {
tenant: '/api/v1/tenants/1',
name: 'Boston Chapter',
fieldType: 'string',
fieldOptions: ['string'],
position: 42,
conditionedField: '/api/v1/custom_fields/1',
conditionedValue: 'string',
isOnlyAdmin: true,
visibility: 'string',
isEncrypted: true,
discriminator: 'string',
fileConfig: ['string'],
exampleMedia: {
size: 42,
contentUrl: 'https://civic-collective.example.com',
type: 'MEMBER',
mimeType: 'application/pdf'
}
},
position: 42,
description: 'Quarterly chapter meeting open to all members.',
isMandatory: true
})
};
fetch('https://app.orgo.space/api/v1/form_fields', 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://app.orgo.space/api/v1/form_fields",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'form' => '/api/v1/forms/1',
'customField' => [
'tenant' => '/api/v1/tenants/1',
'name' => 'Boston Chapter',
'fieldType' => 'string',
'fieldOptions' => [
'string'
],
'position' => 42,
'conditionedField' => '/api/v1/custom_fields/1',
'conditionedValue' => 'string',
'isOnlyAdmin' => true,
'visibility' => 'string',
'isEncrypted' => true,
'discriminator' => 'string',
'fileConfig' => [
'string'
],
'exampleMedia' => [
'size' => 42,
'contentUrl' => 'https://civic-collective.example.com',
'type' => 'MEMBER',
'mimeType' => 'application/pdf'
]
],
'position' => 42,
'description' => 'Quarterly chapter meeting open to all members.',
'isMandatory' => true
]),
CURLOPT_HTTPHEADER => [
"Api-Token: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.orgo.space/api/v1/form_fields"
payload := strings.NewReader("{\n \"form\": \"/api/v1/forms/1\",\n \"customField\": {\n \"tenant\": \"/api/v1/tenants/1\",\n \"name\": \"Boston Chapter\",\n \"fieldType\": \"string\",\n \"fieldOptions\": [\n \"string\"\n ],\n \"position\": 42,\n \"conditionedField\": \"/api/v1/custom_fields/1\",\n \"conditionedValue\": \"string\",\n \"isOnlyAdmin\": true,\n \"visibility\": \"string\",\n \"isEncrypted\": true,\n \"discriminator\": \"string\",\n \"fileConfig\": [\n \"string\"\n ],\n \"exampleMedia\": {\n \"size\": 42,\n \"contentUrl\": \"https://civic-collective.example.com\",\n \"type\": \"MEMBER\",\n \"mimeType\": \"application/pdf\"\n }\n },\n \"position\": 42,\n \"description\": \"Quarterly chapter meeting open to all members.\",\n \"isMandatory\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Api-Token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://app.orgo.space/api/v1/form_fields")
.header("Api-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"form\": \"/api/v1/forms/1\",\n \"customField\": {\n \"tenant\": \"/api/v1/tenants/1\",\n \"name\": \"Boston Chapter\",\n \"fieldType\": \"string\",\n \"fieldOptions\": [\n \"string\"\n ],\n \"position\": 42,\n \"conditionedField\": \"/api/v1/custom_fields/1\",\n \"conditionedValue\": \"string\",\n \"isOnlyAdmin\": true,\n \"visibility\": \"string\",\n \"isEncrypted\": true,\n \"discriminator\": \"string\",\n \"fileConfig\": [\n \"string\"\n ],\n \"exampleMedia\": {\n \"size\": 42,\n \"contentUrl\": \"https://civic-collective.example.com\",\n \"type\": \"MEMBER\",\n \"mimeType\": \"application/pdf\"\n }\n },\n \"position\": 42,\n \"description\": \"Quarterly chapter meeting open to all members.\",\n \"isMandatory\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.orgo.space/api/v1/form_fields")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Api-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"form\": \"/api/v1/forms/1\",\n \"customField\": {\n \"tenant\": \"/api/v1/tenants/1\",\n \"name\": \"Boston Chapter\",\n \"fieldType\": \"string\",\n \"fieldOptions\": [\n \"string\"\n ],\n \"position\": 42,\n \"conditionedField\": \"/api/v1/custom_fields/1\",\n \"conditionedValue\": \"string\",\n \"isOnlyAdmin\": true,\n \"visibility\": \"string\",\n \"isEncrypted\": true,\n \"discriminator\": \"string\",\n \"fileConfig\": [\n \"string\"\n ],\n \"exampleMedia\": {\n \"size\": 42,\n \"contentUrl\": \"https://civic-collective.example.com\",\n \"type\": \"MEMBER\",\n \"mimeType\": \"application/pdf\"\n }\n },\n \"position\": 42,\n \"description\": \"Quarterly chapter meeting open to all members.\",\n \"isMandatory\": true\n}"
response = http.request(request)
puts response.read_body{
"id": 42,
"form": "/api/v1/forms/1",
"customField": {
"id": 42,
"tenant": "/api/v1/tenants/1",
"name": "Boston Chapter",
"fieldType": "string",
"fieldOptions": [
"string"
],
"position": 42,
"conditionedField": "/api/v1/custom_fields/1",
"conditionedValue": "string",
"isOnlyAdmin": true,
"visibility": "string",
"isEncrypted": true,
"discriminator": "string",
"fileConfig": [
"string"
],
"exampleMedia": {
"id": 42,
"size": 42,
"contentUrl": "https://civic-collective.example.com",
"type": "MEMBER",
"mimeType": "application/pdf",
"originalName": "Boston Chapter"
}
},
"position": 42,
"description": "Quarterly chapter meeting open to all members.",
"isMandatory": true
}Authorizations
ApiTokenJWT
Server-to-server authentication. Generate a token in the admin UI at
Settings → Developers → API Access. Send the raw token in the
Api-Token header — there is no Bearer prefix.
Tokens can be marked read-only at creation time, in which case the API
rejects any non-GET request with 403 Forbidden.
Body
application/json
The new FormField resource
⌘I

