Get Custom Field Details

Changed on
get/settings/custom_fields/{custom_field_uid}

Request

  • Base URL
    https://dc-region.zuperpro.com/api
  • URL
    https://dc-region.zuperpro.com/api/settings/custom_fields/{custom_field_uid}
  • Auth
    API key in header x-api-key

Path parameters

custom_field_uidstring required

Response

200

typestring

Example response

{
  "type": "success",
  "data": {
    "custom_field_uid": "bfd918ff-1b6f-4a0e-8759-2083c87013f0",
    "module_name": "JOB",
    "field_name": "test doc",
    "field_type": "SINGLE_LINE",
    "internal_key": "job_test_doc_1",
    "display_order": 2,
    "field_validation": "regex",
    "regex_value": "?\\\\\\\\d",
    "is_required": true,
    "hide_to_fe": true,
    "hide_field": true,
    "read_only": true,
    "is_dependent": true,
    "dependent_on": "Dropdown",
    "dependent_options": [
      "option 1"
    ]
  }
}

Changes