Get Custom Fields

Retrieves all the custom fields created for the org.

ParameterData TypeDescription
nameStringName of the custom field
typeStringType of the field. For example, text, datepicker, checkbox, dropdown etc
dataTypeStringData type of the field.
labelStringLabel assigned to the custom field to identify the custom field. For example, address, date of birt etc.
scopeStringDefines the purpose or where the custom field is used.
defaultValueStringDefault value for the field. This field applies to client-side applications like Instore and does not undergo any server-side validation.
phaseStringThis is applicable for Instore and is not in use.
positionStringPosition of the field. Indicates the order of the field on UI. This field applies to client-side applications like Instore and does not undergo any server-side validation.
ruleStringRule for the field. Client-side validation rule for the field (Infix expression)
serverRuleStringServer-side rule for the field. Server-side validation rule for the field (Infix expression)
regexStringRegular expression for validation. Validation for the field.
errorStringError message for validation
optionsStringDisplays the options available to choose from if it is a drop-down.
isDisabledIntegerWhether the field is disabled (0 or 1).
isCompulsoryIntegerWhether the field is compulsory (0 or 1). This field applies to client-side applications like Instore and does not undergo any server-side validation.
disableAtServerIntegerWhether disabling at server (0 or 1)
isUpdatableIntegerWhether the field is updatable (0 or 1). This field applies to client-side applications like Instore and does not undergo any server-side validation.
enableAuditTrailIntegerWhether enable audit trail is enabled (0 or 1)
isPiiDataIntegerWhether the field is PII data (0 or 1)
isPsiDataIntegerIndicates if the custom field is sensitive data. Refer to the PSI data documentation for more information on classifying PSI data.
Language
Credentials
Basic
base64
:
URL
Click Try It! to start a request and see the response here!