custom_field_types

Custom Field Types

Get data type and other related data for all custom fields for your institution

get/custom_field_types

Request

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

Response

OK

multi_choice_optionsstring[] nullable

List of strings representing all possible values for a multi-choice custom field

include_in_reportsboolean

DEPRECATED. Whether or not the custom field will be displayed in contact reports. This is now set on a per-report basis.

namestring required

Name of valid, existing custom field.

data_type'TEXT' | 'DATE' | 'PHONE' | 'EMAIL' | 'URL' | 'NUMBER' | 'MULTI_CHOICE' | 'BOOLEAN' | 'JSON_STRING_ARRAY' required

Data type for the given custom field

requires_authboolean required

Whether or not the custom field is sensitive and protected.

include_in_escalationsboolean required

Whether or not the custom field will be displayed in escalation email bodies.

include_in_gen_aiboolean required

Whether or not the custom field will be included in generative AI flows.

Changes

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