default_fields

Default Contact Fields

Get list of default (non-custom) Contact fields

get/default_fields

Request

  • Base URL: https://api.mainstay.com
  • URL: https://api.mainstay.com/default_fields
  • Auth: API key in header Authorization

Response

OK

namestring required

Field name

data_type'TEXT' | 'BOOLEAN' | 'DATE' | 'DATETIME' | 'NUMBER' | 'MULTI_CHOICE' | 'ARRAY' | 'OBJECT' required

Field data type

allowed_valuesstring[] required

For multi-choice fields that only accept or yield specific values

requiredboolean required

Whether or not this field is required in write requests

deprecatedboolean required

Whether or not this field is deprecated. If true, its related field is listed in <code>related_field</code> if one exists.

related_fieldstring required

Name of related field for deprecated field

readonlyboolean required

Whether this field is writable or not

Changes

No recorded changes to this operation across all 1 revision of this API.