Get Custom Field

GET 
/locations/:locationId/customFields/:id

Get Custom Field

Request

Version stringrequired

API Version

Available options2023-02-21

locationId stringrequired

Location Id

id stringrequired

Custom Field Id or Field Key (e.g. "contact.first_name" or "opportunity.pipeline_id")

application/json

Successful response

application/json

Schema

Schema

customFieldobject

Example (auto)

{
  "customField": {
    "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"
  }
}