Common Fields

As part of our ongoing standardization efforts, we've been working to establish consistent field naming across forms in all states. However, due to varying requirements for legally prescribed forms across different states, we've determined that the best approach is to set common names where possible and provide complete field lists for each state in CSV format.

These downloadable CSV lists can be parsed programmatically by integrators to determine which fields are needed to satisfy the requirements of your integration.

PUT/forms/:id/save

Update form field values

This endpoint allows you to update the field values within a form. You can update multiple fields in a single request by providing field name and value pairs in the request body.

Use the state-specific field lists below to identify valid field names for your forms.

Optional attributes

  • Name
    field_name
    Type
    string
    Description

    Any valid field name from the form template. Multiple fields can be updated in a single request.

Request

PUT
/forms/1/save
curl https://app-api.reiformslive.com.au/forms/1/save \
  --request PUT \
  --header "Content-Type: application/json" \
  --header "Authorization: Basic YTlkOWIwYItNGY4Yi1hYTQxLTI5NzZmMTcyZmEyMQ==" \
  --data '{
    "property_address": "123 Main Street",
    "sale_price": "750000",
    "settlement_date": "2024-12-31"
  }'

Response

{
  "message": "The form has been saved."
}

State-specific field lists

We provide comprehensive field lists for each Australian state and territory, allowing you to access the exact field requirements for your specific integration needs.

  • Name
    Format
    Type
    string
    Description

    CSV (Comma-Separated Values)

  • Name
    Organization
    Type
    string
    Description

    Lists are organized by state, with each CSV containing all form fields broken down by form code

  • Name
    Updates
    Type
    string
    Description

    Field lists are regularly updated as form requirements change or new forms are added

Download field lists by state

Access the complete field lists for each Australian state and territory:

State/TerritoryField List
NSWDownload NSW Fields
QLDDownload QLD Fields
VICDownload VIC Fields
WADownload WA Fields
SADownload SA Fields
TASDownload TAS Fields
NTDownload NT Fields
ACTDownload ACT Fields

Working with field lists

The field lists provide you with a comprehensive mapping of all available fields for each form in a specific state. This allows you to:

  1. Identify required fields for specific forms
  2. Map your own data structures to Forms Live field names
  3. Ensure form submissions contain all necessary data
  4. Understand field naming conventions across different forms

Example: Parsing field lists

import Papa from 'papaparse'
import fs from 'fs'

// Read the CSV file
const csvFile = fs.readFileSync('nsw-fields.csv', 'utf8')

// Parse the CSV data
Papa.parse(csvFile, {
  header: true,
  complete: (results) => {
    // Filter fields for a specific form
    const formFields = results.data.filter(
      field => field.form_code === 'T1000'
    )

    console.log('Fields for T1000 form:', formFields)
  }
})

Field standardization

While we maintain state-specific field requirements, we also continuously work toward standardizing common fields across all states. This standardization effort aims to:

  1. Simplify integration across multiple states
  2. Reduce development overhead
  3. Improve data consistency
  4. Enable more efficient cross-state operations

If you have suggestions for field standardization or encounter inconsistencies in field naming, please contact our developer support team.

Learn more about working with Forms