Forms

List a field's compatible types

GET/form-fields/{fieldId}/compatible-types
forms:readget_compatible_field_typesRead-onlyDeprecatedSunset 2027-06-30

Lists the field types the given field can be safely changed to. With no answers a field can become any convertible type; once answered it is constrained to its conversion group. A field of a hidden form returns 404. Deprecated: withdrawn on 2027-06-30. GET /forms/{form_id}/fields/{id}/compatible-types replaces it; every answer carries a Link header with rel="successor-version" to that route.

Path parameters

  • fieldIdstring (uuid)Required#

    The form field's public uuid.

Responses

200

OK

CompatibleFieldTypes
{
  "data": {
    "current_type": "TEXT",
    "has_answers": false,
    "compatible_types": [
      "TEXT",
      "BIGTEXT"
    ]
  }
}
401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
404

Resource not found (error.code = not_found).

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl https://your-org-domain/kong/core/api/v2/form-fields/{fieldId}/compatible-types\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"