Document Mass Uploads

List the files of a mass upload

GET/document-mass-uploads/{document_mass_upload_id}/items
documents:readlist_document_mass_upload_itemsRead-only

Lists the files the zip's plan found, one for each file and folder pair, ordered by id, one page at a time. A failed file's error says why; revert_outcome says what the latest revert did with its document. An upload still uploading has none. An unknown upload, or another organisation's, returns 404. Gate: view-all-documents or super admin only, else 403 missing_permission (forbidden for a token with no user). POST .../items/exports makes a failed-file report. It changes nothing.

Path parameters

  • document_mass_upload_idstring (uuid)Required#

    The mass upload's id.

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: id. Prefix a field with - for descending. Defaults to id.

  • filter[status]string#

    Files in this status: pending, succeeded or failed. Takes [in] and [not_in] with a comma-separated list.

    One of: pending, succeeded, failed
  • filter[q]string#

    Files whose name contains this text, in any case.

  • filter[revert_outcome]string#

    Files the latest revert ended this way: deleted, missing or failed. Send filter[revert_outcome][null]=true for files no revert has reached. Takes [in] and [not_in] with a comma-separated list.

    One of: deleted, missing, failed

Responses

200

The files.

DocumentMassUploadItem[]
{
  "data": [
    {
      "id": 1,
      "filename": "string",
      "folder_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
      "status": "pending",
      "document_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
      "error": "string",
      "revert_outcome": "deleted",
      "revert_reason": "string",
      "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
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/document-mass-uploads/{document_mass_upload_id}/items\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"