NGngpvan

/customFields/{customFieldId}

Changed on

Use this endpoint to retrieve information about a specific Custom Field available in the current context.

get/customFields/{customFieldId}

Request

  • Base URL
    https://api.securevan.com/v4
  • URL
    https://api.securevan.com/v4/customFields/{customFieldId}
  • Auth
    HTTP basic

Path parameters

customFieldIdinteger required

Unique identifier for a specific Custom Field.

Response

200

customFieldIdinteger
customFieldParentIdunknown
customFieldNamestring
customFieldGroupIdinteger
customFieldGroupNamestring
customFieldGroupTypestring
customFieldTypeIdstring
isEditableboolean
maxTextboxCharactersunknown

Example response

{
  "customFieldId": 157,
  "customFieldName": "Education level",
  "customFieldGroupId": 52,
  "customFieldGroupName": "Education",
  "customFieldGroupType": "Contacts",
  "customFieldTypeId": "S",
  "isEditable": true,
  "availableValues": [
    {
      "id": 1,
      "name": "High School diploma"
    }
  ]
}

Changes