NGngpvan

/customFields

Changed on

Use this endpoint to retrieve all Custom Fields that are available in the current context.

get/customFields

Request

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

Query parameters

customFieldsGroupTypestring

Optional; filter by the specified Custom Field Group Type. Default value is Contacts. If provided, must be Contacts, Contributions, or Disbursements.

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