Folder Imports

Get a folder import

GET/folder-imports/{id}
documents:readget_folder_importRead-only

Returns one import with its counts and the state of its job and latest revert. An unknown id returns 404. Needs the permission to view all documents in all deals, or super admin, on the token's user; any other token gets 403 missing_permission. Use GET /folder-imports to list imports. It changes nothing.

Path parameters

  • idstring (uuid)Required#

    The record's id.

Query parameters

  • fieldsstring#

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

Responses

200

The import.

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"
  }
}
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/folder-imports/{id}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"