ContactFieldList resource

Methods

  • get - Get contact fields list

Resource

{
    "links": {
        "next": "uri",
        "prev": "uri"
    },
    "results": [
        {
            "custom": "boolean",
            "defaultCountryCode": "string",
            "defaultValue": "string",
            "id": "string",
            "maxDate": "string",
            "maxLength": "number",
            "maxValue": "number",
            "minDate": "string",
            "minValue": "number",
            "name": "string",
            "options": [
                {
                    "id": "string",
                    "label": "string"
                }
            ],
            "readOnly": "boolean",
            "required": "boolean",
            "type": "string"
        }
    ]
}

Properties

Name Type Description Additional
links object

The pagination links

 Optional
links.next uri

The next list page url if there are more elements

 Optional
links.prev uri

The previous list page url if there is a previous page
results[] array

The contact field list
results[].custom boolean

Indicates if the field is custom. Custom fields are created by the member of the store.
results[].defaultCountryCode string

Indicates if the default country code of the phone field. Only available when the field type is "phone".

 Optional
results[].defaultValue string

The default value of the field. Default value must be set always when the field is required.

 Optional
results[].id string

The identifier of the field
results[].maxDate string

Indicates if the max valid date of a date field. Only available when the field type is "date".

 Optional
results[].maxLength number

Indicates if the max length of the text field. Only available when the field type is "text".

 Optional
results[].maxValue number

Indicates if the max valid value of a field. Only available when the field type is "integer" or "decimal".

 Optional
results[].minDate string

Indicates if the min valid date of a date field. Only available when the field type is "date".

 Optional
results[].minValue number

Indicates if the min valid value of a field. Only available when the field type is "integer" or "decimal".

 Optional
results[].name string

The name of the field
results[].options[] array

Indicates the allowed options of a field. Only available when the field type is "checkbox" or "radio".

 Optional
results[].options[].id string

The identifier of the option
results[].options[].label string

The label of the option
results[].readOnly boolean

Indicates if the field is read only. If true the field value cannot be modified.
results[].required boolean

Indicates if the field is required. When a field is required it means that a contact must have always a value for that field. A required field must always have a default value set.
results[].type string

The type of the field

Possible values are:

  • text
  • integer
  • decimal
  • boolean
  • date
  • radio
  • checkbox
  • phone
  • email