Sign in

v2

latestOpenAPI 3.0.3Apache 2.02026-07-31158109678.6 KB
institutions

Group custom fields

Returns the custom fields for the specified group. Deprecated in favour of GET /account/items/fields/configuration/{item_type_id}. Will be removed after 2027-01-01.

get/account/groups/{group_id}/metadata/item

Path parameters

group_idinteger required

Group unique identifier

Response

OK. An array of custom fields

namestring required

Custom metadata name

valueobject required

Custom metadata value (can be either a string or an array of strings)

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

Custom field type

settingsobject required

Settings for the custom field

orderinteger required

Order of the custom field

is_mandatoryboolean required

Whether the field is mandatory or not

Example response

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