Forms

Get a field of a form

GET/forms/{form_id}/fields/{id}
forms:readget_form_fieldRead-only

Returns one field of the form. An unknown or hidden form, or a field of another form, returns 404. Use GET /forms/{form_id}/fields to list them. It changes nothing.

Path parameters

  • form_idstring (uuid)Required#

    The form's id, a uuid. An unknown id, or a hidden form, returns 404.

  • idstring (uuid)Required#

    The field's id, a uuid. A field of another form returns 404.

Query parameters

  • fieldsstring#

    Comma-separated top-level fields to return. id is always returned.

Responses

200

The field.

FormField
{
  "data": {
    "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "label": "string",
    "name": "string",
    "description": "string",
    "type": "string",
    "reference": "string",
    "validator": "string",
    "placeholder": "string",
    "pre_population_key": "string",
    "backfill": true,
    "order": 1,
    "page_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "option_preset_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "options": [
      null
    ],
    "required": true,
    "conditions": [
      {
        "against_field_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
        "against_field_reference": "string",
        "operator": "string",
        "value": "string"
      }
    ],
    "condition_logic": "AND"
  }
}
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
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl https://your-org-domain/kong/core/api/v2/forms/{form_id}/fields/{id}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"