Forms

Get a form file

GET/form-files/{id}
forms:readget_form_fileRead-only

Returns one file's name and size; the bytes are GET /form-files/{id}/download. A file is readable when your organisation uploaded it, or when it is an answer on a submission you can see (a file field's answer; its user is in your organisation and not a service user, its form is not hidden, and it is not deleted). Any other file, a deleted one or an unknown id is 404. It changes nothing.

Path parameters

  • idstring (uuid)Required#

    The form file's id, a uuid. An unknown id, or a file you cannot see, returns 404.

Query parameters

  • fieldsstring#

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

Responses

200

The form file.

FormFile
{
  "data": {
    "id": "1a2b3c4d-5e6f-4071-8293-a4b5c6d7e8f9",
    "name": "passport.pdf",
    "size": 248173,
    "created_at": "2026-06-15T10:30:00Z",
    "updated_at": "2026-06-15T10:30:00Z"
  }
}
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/form-files/{id}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"