Forms

List forms

GET/forms
forms:readlist_formsRead-only

Lists the non-hidden forms, oldest first, and returns one page. Forms are tenant-wide, so every token sees the same list. Each form carries its status (draft or published), its pages and its fields. Filter by filter[status], filter[type], filter[q] (name) and a filter[created_at] range. Use GET /forms/{id} for one form. It changes nothing.

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.

  • fieldsstring#

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

  • sortstring#

    Comma-separated fields to sort by: created_at, updated_at or name. Prefix a field with - for descending. Defaults to created_at, oldest first. The form id is always the final tiebreak.

  • filter[q]string#

    Forms whose name contains this text, ignoring case.

  • filter[status]string#

    Only forms in this status: draft or published. Takes [in] and [not_in] with a comma-separated list.

    One of: draft, published
  • filter[type]string#

    Only forms of this type: STANDARD, CUSTOM, COMPLIANCE or CUSTOM_USER_DATA_CAPTURE. Takes [in] and [not_in] with a comma-separated list.

    One of: STANDARD, CUSTOM, COMPLIANCE, CUSTOM_USER_DATA_CAPTURE
  • filter[created_at]string#

    Only forms created in a range, written filter[created_at][gte]=2026-10-01. Takes gt, gte, lt and lte.

  • filter[updated_at]string#

    Only forms changed in a range, written filter[updated_at][gte]=2026-10-01. Takes gt, gte, lt and lte.

Responses

200

One page of forms.

Form[]
{
  "data": [
    {
      "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
      "name": "string",
      "description": "string",
      "type": "string",
      "status": "draft",
      "pages": [
        {}
      ],
      "fields": [
        {}
      ],
      "created_at": "2026-06-12T10:00:00+00:00",
      "updated_at": "2026-06-12T10:00:00+00:00"
    }
  ],
  "meta": {
    "limit": 1,
    "next_cursor": "string",
    "prev_cursor": "string"
  }
}
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
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\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"