Common models


  • B = Boolean (Checkbox)
  • S = Selection (Dropdown)
  • T = Text
  • D = Date
  • N = Number
  • M = Money (Currency)
    "customFieldId": 157,
    "customFieldParentId": null,
    "customFieldName": "Education level",
    "customFieldGroupId": 52,
    "customFieldGroupName": "Education",
    "customFieldGroupType": "Contacts",
    "customFieldTypeId": "S",
    "isEditable": true,
    "isExportable": false,
    "maxTextboxCharacters": null,
    "availableValues": [
        "id": 1,
        "name": "High School diploma",
        "parentValueId": null
        "id": 2,
        "name": "College degree",
        "parentValueId": null
        "id": 3,
        "name": "Postgraduate degree",
        "parentValueId": null
        "id": 4,
        "name": "Doctorate",
        "parentValueId": null

Custom Field

customFieldIdintUnique identifier for a Custom Field in this context
customFieldParentIdintIdentifies a Selection’s parent (Only applies to hierarchical Selections)
customFieldNamestringThe name for the Custom Field, no longer than 255 characters
customFieldGroupIdintUnique identifier for the Custom Field Group to which this Custom Field belongs
customFieldGroupNamestringThe name of the Custom Field Group to which this Custom Field belongs, no longer than 60 characters
customFieldGroupTypestringThe type of Custom Field Group (must be Contacts, Contributions, or Disbursements)
customFieldTypeIdstringA one character identifier of the Custom Field type
isEditableboolIndicates whether or not the value assigned to the Custom Field can be changed
isExportableboolIndicates whether or not the Custom Field may be included in an Export Job
maxTextboxCharactersintThe maximum number of characters allowed in the text field. (Only applies to Text or Number fields)
availableValuesarrayAn array of available values. (Only applies to Selections)

Available Value

idintThe value of the Selection option
namestringThe text of the Selection option, no longer than 100 characters
parentValueIdintThe id of the the Selection option in the Custom Field’s parent Selection (Only applies to hierarchical Selections)