User Data Capture

Get a data capture form

GET/data-capture-forms/{id}
user-data-capture:readget_data_capture_formRead-only

Returns one data capture form with its status, pages and fields. The id is the data capture form's own, not the id of the hidden form underneath it. A deleted or unknown id returns 404. Use GET /data-capture-forms to list forms. It changes nothing.

Path parameters

  • idstring (uuid)Required#

    The data capture form's id, a uuid. An unknown or deleted id returns 404.

Query parameters

  • fieldsstring#

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

Responses

200

The data capture form.

DataCaptureForm
{
  "data": {
    "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "name": "string",
    "status": "enabled",
    "field_count": 1,
    "pages": [
      {
        "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
        "name": "string",
        "description": "string",
        "order": 1
      }
    ],
    "fields": [
      {
        "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": [],
        "required": true,
        "conditions": [],
        "condition_logic": "AND"
      }
    ],
    "created_at": "2026-06-12T10:00:00+00:00",
    "updated_at": "2026-06-12T10:00:00+00:00"
  }
}
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/data-capture-forms/{id}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"