Folder Imports

List folder imports

GET/folder-imports
documents:readlist_folder_importsRead-only

Lists the folder imports, newest first, and returns one page. Each says what the import did and the state of its job and of its latest revert. Needs the permission to view all documents in all deals, or super admin, on the token's user; any other token, service tokens included, gets 403 missing_permission. Use GET /folder-imports/{id} for one import and GET /folder-imports/{folder_import_id}/folders for its folders. 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.

Responses

200

The imports.

FolderImport[]
{
  "data": [
    {
      "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
      "file_name": "string",
      "job_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
      "status": "pending",
      "rows_total": 1,
      "users_total": 1,
      "folders_created": 1,
      "folders_existing": 1,
      "skipped_total": 1,
      "failures_total": 1,
      "revert_job_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
      "revert_status": "pending",
      "revert_requested_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"
    }
  ],
  "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/folder-imports\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"