Field types

Needs: Forms, Read

Returns every form field type with its settings and value shape, the rules for conditional visibility and routing, and the incident, prospect and client pre-fill targets, including your organisation's custom attributes. Read it before building a form.

Field type groups

Category	Types
Input	`text`, `email`, `phone`, `address`, `url`, `richtext`, `textarea`, `tags`, `number`
Selection	`select`, `multiselect`, `language_select`, `radio`, `checkbox`, `staff_select`, `client_select`, `linear_scale`, `rating`
Date and time	`date`, `time`, `datetime`
Layout	`heading`, `paragraph`, `rich_paragraph`, `button`, `divider`
Assessment	`assessment_annotate`
Advanced	`embed`, `signature`, `table`, `pricing_table`, `freeform_table`, `file`

staff_select and client_select are internal only, so a form that has them cannot be published live.

curl -X GET "https://app.imploy.com.au/api/integrations/v1/forms/field-types" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

import requests
import json

url = "https://app.imploy.com.au/api/integrations/v1/forms/field-types"
headers = {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN"
}

response = requests.get(url, headers=headers)
print(response.json())

const response = await fetch("https://app.imploy.com.au/api/integrations/v1/forms/field-types", {
  method: "GET",
  headers: {
  "Content-Type": "application/json",
  "Authorization": "Bearer YOUR_API_TOKEN"
}
});

const data = await response.json();
console.log(data);

package main

import (
    "fmt"
    "net/http"
)

func main() {

    req, err := http.NewRequest("GET", "https://app.imploy.com.au/api/integrations/v1/forms/field-types", nil)
    if err != nil {
        panic(err)
    }

    req.Header.Set("Content-Type", "application/json")
    req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    fmt.Println("Response Status:", resp.Status)
}

require 'net/http'
require 'json'

uri = URI('https://app.imploy.com.au/api/integrations/v1/forms/field-types')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'

response = http.request(request)
puts response.body

{
  "types": [
    {
      "type": "text",
      "label": "Short Text",
      "category": "input",
      "value": "string"
    }
  ],
  "field_settings": {
    "all": "...",
    "choices": "...",
    "conditions": "...",
    "routing": "..."
  },
  "defaults": "...",
  "mapping_targets": {
    "incident": {},
    "prospect": {},
    "client_prefill": {}
  }
}