Forms

Get a generated document

GET/submissions/{submission_id}/documents/{id}
forms:readget_submission_documentRead-only

Returns the generated document's details as JSON: its template, name and when it was generated. The file itself is GET /submissions/{submission_id}/documents/{id}/download; this used to stream it. A document of another submission is 404. It changes nothing.

Path parameters

  • submission_idstring (uuid)Required#

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

  • idstring (uuid)Required#

    The generated document's id, a uuid. An unknown id, or a document of another submission, returns 404.

Query parameters

  • fieldsstring#

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

Responses

200

The generated document.

GeneratedDocument
{
  "data": {
    "id": "9f010203-4a5b-4c6d-8e7f-8091a2b3c4d5",
    "submission_id": "7d8e9f01-2a3b-4c5d-9e6f-708192a3b4c5",
    "template_id": "d4e5f607-1829-4a3b-9c4d-5e6f708192a3",
    "name": "Subscription Agreement - Ada Lovelace.pdf",
    "generated_at": "2026-06-15T10:30:00Z",
    "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/submissions/{submission_id}/documents/{id}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"