Folder Imports

List the folders of a folder import

GET/folder-imports/{folder_import_id}/folders
documents:readlist_folder_import_foldersRead-only

Lists what the import did with each row of its file, ordered by id, and returns one page. outcome is created, existing, skipped or failed, and revert_outcome says what the latest revert did. An unknown import returns 404 naming it. 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 the import's totals. It changes nothing.

Path parameters

  • folder_import_idstring (uuid)Required#

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

  • filter[outcome]string#

    Rows with this outcome: created, existing, skipped or failed. Takes [in] and [not_in] with a comma-separated list.

    One of: created, existing, skipped, failed
  • filter[revert_outcome]string#

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

    One of: deleted, kept_not_empty, missing, failed
  • filter[user_id]string (uuid)#

    Rows for this user. Takes [in] and [not_in] with a comma-separated list.

Responses

200

The rows.

FolderImportFolder[]
{
  "data": [
    {
      "id": 1,
      "user_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
      "path": "string",
      "depth": 1,
      "folder_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
      "outcome": "created",
      "reason": "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/folder-imports/{folder_import_id}/folders\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"