Get a form

Needs: Forms, Read

Returns a form outline: steps, fields (id, type, label, required, options, visibility), routing, settings, incident, prospect and pre-fill mappings, the link, and any issues. Use step_id or field_id to get one step or one field in full.

Note: The outline also lists the steps with their fields. published is public, internal or off, and url is the live link when the form is published.

curl -X GET "https://app.imploy.com.au/api/integrations/v1/forms/123?step_id=example_string&field_id=example_string" \
  -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/123?step_id=example_string&field_id=example_string"
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/123?step_id=example_string&field_id=example_string", {
  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/123?step_id=example_string&field_id=example_string", 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/123?step_id=example_string&field_id=example_string')
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

{
  "id": 14,
  "name": "Visit feedback",
  "description": "Collect feedback after a visit.",
  "published": "off",
  "url": null,
  "settings": {
    "allow_step_navigation": false,
    "show_step_numbers": true,
    "submit_button_text": "Submit"
  }
}