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 Site Metadata > 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
  }

Endpoints