Document Mass Uploads

List mass uploads

GET/document-mass-uploads
documents:readlist_document_mass_uploadsRead-only

Lists the token's organisation's mass uploads, and those the legacy routes made with no organisation, newest first, one page at a time. Each shows its status, zip name and size, uploader id, job, file counts, failure reason and latest revert. Gate: view-all-documents or super admin only, else 403 missing_permission (forbidden for a token with no user). See GET /document-mass-uploads/{id} for one, .../{document_mass_upload_id}/items for its files and POST /document-mass-uploads/exports for a CSV. It changes nothing.

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

  • filter[status]string#

    Uploads in this status: uploading, queued (completed, job not started), processing, completed, completed_with_failures, failed, cancelled, reverting, reverted or revert_failed. Takes [in] and [not_in] with a comma-separated list.

    One of: uploading, queued, processing, completed, completed_with_failures, failed, cancelled, reverting, reverted, revert_failed
  • filter[q]string#

    Uploads whose zip name, or whose uploader's name, contains this text, in any case.

  • filter[created_at]string#

    Only uploads started in a range, written filter[created_at][gte]=2026-10-01. Takes gt, gte, lt and lte.

Responses

200

The uploads.

DocumentMassUpload[]
{
  "data": [
    {
      "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
      "status": "uploading",
      "filename": "string",
      "size_bytes": 1,
      "owner_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
      "job_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
      "summary": {
        "total": 1,
        "processed": 1,
        "succeeded": 1,
        "failed": 1
      },
      "failure_reason": "string",
      "cancelled_at": "2026-06-12T10:00:00+00:00",
      "revert": {
        "job_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
        "status": "pending",
        "requested_at": "2026-06-12T10:00:00+00:00",
        "deleted": 1,
        "missing": 1,
        "failed": 1
      },
      "upload": {
        "part_size": 1,
        "part_count": 1,
        "expires_at": "2026-06-12T10:00:00+00:00"
      },
      "created_at": "2026-06-12T10:00:00+00:00",
      "updated_at": "2026-06-12T10:00:00+00:00",
      "completed_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
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\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"