Forms

Get a submission

GET/submissions/{id}
forms:readget_submissionRead-only

Returns one submission with its answers. File answers read as {uuid, name, size} (name and size are null when the file is gone) and masked answers as null. include=documents adds the generated documents. A submission of another organisation's user, a service user, a hidden form or a deleted submission is 404. It changes nothing.

Path parameters

  • idstring (uuid)Required#

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

Query parameters

  • fieldsstring#

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

  • includestring#

    Set to documents to embed the documents generated from the submission, oldest first.

Responses

200

The submission.

FormSubmission
{
  "data": {
    "id": "7d8e9f01-2a3b-4c5d-9e6f-708192a3b4c5",
    "form_id": "c3d4e5f6-0718-4293-a4b5-c6d7e8f90112",
    "user_id": "6f1c2e8a-1b2c-4d5e-8f90-1a2b3c4d5e6f",
    "status": "completed",
    "started_at": "2026-06-15T10:30:00Z",
    "completed_at": "2026-06-15T10:35:00Z",
    "answers": {
      "a1b2c3d4-e5f6-4071-8293-a4b5c6d7e8f9": "Ada Lovelace",
      "b2c3d4e5-f607-4182-93a4-b5c6d7e8f901": 250000
    },
    "created_at": "2026-06-15T10:30:00Z",
    "updated_at": "2026-06-15T10:35: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/submissions/{id}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"