Get Custom Fields

GET 
/locations/:locationId/customFields

Get Custom Fields

Request

Version stringrequired

API Version

Available options2023-02-21

locationId stringrequired

Location Id

model string

Model of the custom field you want to retrieve

Available optionscontactopportunityall

application/json

Successful response

application/json

Schema

Schema

customFieldsobject[]

Example (auto)

{
  "customFields": [
    {
      "id": "3sv6UEo51C9Bmpo1cKTq",
      "name": "pincode",
      "fieldKey": "contact.pincode",
      "placeholder": "Pin code",
      "dataType": "TEXT",
      "position": 0,
      "picklistOptions": [
        "first option"
      ],
      "picklistImageOptions": [],
      "isAllowedCustomOption": false,
      "isMultiFileAllowed": true,
      "maxFileLimit": 4,
      "locationId": "3sv6UEo51C9Bmpo1cKTq",
      "model": "opportunity",
      "urlValidation": {
        "mode": "allow_only",
        "allowedDomains": [
          "example.com"
        ]
      },
      "dateTimeValidation": {
        "mode": "range",
        "rangeMin": "2026-01-01",
        "rangeMax": "2026-12-31"
      },
      "userFieldConfig": {
        "multiSelect": false
      },
      "optionDisplayType": "TEXT_WITH_IMAGE"
    }
  ]
}