Forms

List a submission's generated documents

GET/submissions/{submission_id}/documents
forms:readlist_submission_documentsRead-only

Lists the documents generated from the submission, oldest first, and returns one page. Deleted documents are left out. A submission you cannot see is 404. Use POST /submissions/{id}/actions/generate-documents to make one. 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.

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 or updated_at. Prefix a field with - for descending. Defaults to created_at, oldest first. The document id is always the final tiebreak.

Responses

200

One page of generated documents.

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"
    }
  ],
  "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
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\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"