Custom Fields

This documentation has moved to the Spark Platform website. Please click here to view.

The Custom Fields service allows retrieval of a list of supported custom fields and associated data types.

Applicable API Key Roles

This service is available to API keys with private or IDX roles. Within the IDX role, both IDX and Portal permissions may access this service. More information about roles may be found here.


Requests must be authenticated according to these instructions or HTTP 401 (Unauthorized) will be returned.

Available Services

Get custom fields

URI: /<API Version>/customfields/X

The X in the URI above needs to be replaced with a single property type MlsCode from the Property Types Service . For example, a URI might be: http://<API Version>/customfields/A for property type A.

Data Types

The following data types are available:

  • Character
  • Integer
  • Decimal
  • Boolean
  • Date

Typically, the Integer data type is used for numbers that are not displayed with a comma, whereas the Decimal data type indicates to format numbers with a comma.

GET Request


  • None

GET Response

This sample response shows the possible data types noted above.

    "D": {
        "Success": true,
        "Results": [
                "General Property Description": {
                    "Guest House SqFt": {
                        "Type": "Decimal"
                    "Dwelling Type": {
                        "Type": "Character"
                "Energy/Green Feature": {
                    "Multi-Zones": {
                        "Type": "Boolean"
                    "Solar PV Panels": {
                        "Type": "Boolean"
                "Green/Energy": {
                    "Certification Year": {
                        "Type": "Integer"
                "Rental Info": {
                    "Vacancy Date": {
                        "Type": "Date"

Comments on this entry are closed.