Sign in

v2

latestOpenAPI 3.0.3Apache 2.02026-07-31158109678.6 KB
institutions

Private account institution group custom fields

Returns the custom fields in the group the user belongs to, or the ones in the group specified, if the user has access. Deprecated in favour of GET /account/items/fields/configuration/{item_type_id}. Will be removed after 2027-01-01.

get/account/institution/custom_fields

Query parameters

group_idinteger

Group_id

Response

OK. An array of custom fields

idinteger required

Custom field id

namestring required

Custom field name

field_type'text' | 'textarea' | 'dropdown' | 'url' | 'email' | 'date' | 'dropdown_large_list' required

Custom field type

settingsobject

Settings for the custom field

orderinteger

Order of the field in the group

is_mandatoryboolean

Whether the field is mandatory or not

Example response

[
  {
    "id": 365,
    "name": "my custom field",
    "field_type": "textarea",
    "settings": {
      "validations": {
        "min_length": 1,
        "max_length": 1000
      },
      "placeholder": "Enter your custom field here"
    },
    "order": 1
  }
]