User Data Capture

List the firm's User Data Capture forms

GET/user-data-capture/forms
user-data-capture:readlist_user_data_capture_forms_legacyRead-onlyDeprecatedSunset 2027-06-30

Cursor-paginated list of the firm's User Data Capture forms, in the old shape: status is Enabled, Disabled or Enabled for Internal Users, timestamps end in +00:00, and rows carry field_count only: GET /user-data-capture/forms/{formId} has the fields. Deprecated: withdrawn on 2027-06-30. GET /data-capture-forms replaces it; the Link header names it.

Query parameters

  • limitinteger#

    Page size (1–100). Defaults to 25; values are clamped to the range.

    Default: 25
  • cursorstring#

    Opaque pagination cursor taken from a prior response's meta.next_cursor.

Responses

200

OK

{
  "data": [
    {
      "id": "6f1c2e8a-1b2c-4d5e-8f90-1a2b3c4d5e6f",
      "name": "KYC profile",
      "status": "Enabled",
      "field_count": 3,
      "created_at": "2026-06-15T10:30:00+00:00",
      "updated_at": "2026-06-20T14:05:12+00:00"
    },
    {
      "id": "a2d4b6c8-3e5f-4071-9a2b-7c8d9e0f1a2b",
      "name": "Suitability questionnaire",
      "status": "Disabled",
      "field_count": 0,
      "created_at": "2026-05-02T09:12:44+00:00",
      "updated_at": "2026-05-02T09:12:44+00:00"
    }
  ],
  "links": {
    "first": null,
    "last": null,
    "prev": null,
    "next": "https://api.example.com/v2/user-data-capture/forms?cursor=eyJpZCI6MiwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cnVlfQ"
  },
  "meta": {
    "path": "https://api.example.com/v2/user-data-capture/forms",
    "per_page": 25,
    "next_cursor": "eyJpZCI6MiwiX3BvaW50c1RvTmV4dEl0ZW1zIjp0cnVlfQ",
    "prev_cursor": null
  }
}
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
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl https://your-org-domain/kong/core/api/v2/user-data-capture/forms\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"