Fields

The following example shows the response format for Fields in the Schema APIs. Each param describes a given field's attributes and constraints — such as its ID, type, display name, APIName, whether it's a required field, calculated field, and more. Certain field types may provide additional attributes that are relevant.

To learn more about the different field types, see Field Types and System Field Types.

Response Format Examples

  {
    "apiName": "Name",
    "fieldType": 1,
    "isRequired": true,
    "allowDuplicates": false,
    "warnOnNearDuplicates": false,
    "isMoney": false,
    "isMultiSelect": false,
    "entryLists": [],
    "systemFieldType": 9,
    "isKey": false,
    "isCalculated": false,
    "isAttachment": false,
    "isStoreRequestSupported": true,
    "id": 18657,
    "name": "Name",
    "entryListId": 18656
  }

Conditionally Required Fields

When a field has conditional requirements configured on the entry form, the response will include a requiredWhen property. This property can appear on any field type and defines the conditions under which the field becomes required, based on the values of other fields.

  {
    "apiName": "Deal Stage",
    "fieldType": 2,
    "isRequired": true,
    ...
    "requiredWhen": [
      {
        "fieldId": 21569,
        "value": [
          1
        ],
        "filterOperation": 0
      },
      {
        "fieldId": 18662,
        "value": "914671",
        "filterOperation": 0
      }
    ],
...
  }

Each object in the requiredWhen array specifies a condition:

Endpoints