Client Snapshot Field

Output representation of a single resolved field on the household snapshot, including its API name, data type, label, and value.

JSON Example 

1{
2      "fieldApiName": "Name",
3      "dataType": "String",
4      "label": "Name",
5      "value": "Jane Smith",
6      "metadata": null
7    }

Properties 

Property NameTypeDescriptionFilter Group and VersionAvailable Version
dataTypeStringData type of the field value. This value determines how the field is formatted and displayed. Valid values are String, Email, Phone, URL, Currency, Date, and Badge.Big, 67.067.0
fieldApiNameStringAPI name of the field associated with the account. For example, Name, PersonEmail, Phone, and FinServ__AUM__c.Big, 67.067.0
labelStringDisplay label of the field.Big, 67.067.0
metadataObjectJSON object that contains additional parameters for specific field types. For example, for fields of type reference, it includes referenceRecordId and referenceObjectApiName. Shows null if there’s no additional metadata.Big, 67.067.0
valueStringValue of the field. Shows null if the field has no value on the record. Fields that you don’t have access to are excluded from the response body.Big, 67.067.0