---
title: "List objects"
method: POST
path: "/operations/list"
---

# List objects

`POST /operations/list`

Lists objects and directories for a remote path, returning the same fields as `rclone lsjson`.

## Query parameters

- `fs` string
- `remote` string
- `opt` string
- `recurse` boolean
- `noModTime` boolean
- `showEncrypted` boolean
- `showOrigIDs` boolean
- `showHash` boolean
- `noMimeType` boolean
- `dirsOnly` boolean
- `filesOnly` boolean
- `metadata` boolean
- `hashTypes` string[]
- `_group` string
- `_async` boolean

## Headers

- `Prefer` 'respond-async'

## Request body

- OperationsListRequest
  - `fs` string — Remote name or path to list, for example `drive:`.
  - `remote` string — Directory path within `fs` to list; leave empty to target the root.
  - `opt` string — Optional JSON-encoded object of listing flags (e.g. `{ "recurse": true, "showHash": true }`).
  - `recurse` boolean — Set to true to list directories recursively.
  - `noModTime` boolean — Set to true to omit modification times for faster listings on some backends.
  - `showEncrypted` boolean — Set to true to include encrypted names when using crypt remotes.
  - `showOrigIDs` boolean — Set to true to include original backend identifiers where available.
  - `showHash` boolean — Set to true to include hash digests for each entry.
  - `noMimeType` boolean — Set to true to omit MIME type detection.
  - `dirsOnly` boolean — Set to true to return only directory entries.
  - `filesOnly` boolean — Set to true to return only file entries.
  - `metadata` boolean — Set to true to include backend-provided metadata maps.
  - `hashTypes` string[] — Specify one or more hash algorithms to include when `showHash` is true (e.g. `md5`).
  - `_group` string — Assign the request to a custom stats group.
  - `_async` boolean — Run the command asynchronously. Returns a job id immediately.

## Response `200`

Directory listing entries from `operations/list`, mirroring the `lsjson` format.

- object
  - `list` object[], required — Array of entries equivalent to the items returned by `rclone lsjson`.
    - `Path` string, required — Path relative to the requested remote root.
    - `Name` string, required — Base name of the entry.
    - `Size` number — Object size in bytes.
    - `MimeType` string — MIME type where available.
    - `ModTime` string — Modification timestamp in RFC3339 format.
    - `IsDir` boolean, required — True if the entry represents a directory.
    - `Hashes` object — Hash digests keyed by algorithm when requested.
    - `ID` string — Backend-specific identifier when provided.
    - `OrigID` string — Original backend identifier when recorded.
    - `IsBucket` boolean — True for bucket/root entries on bucket-based remotes.
    - `Tier` string — Storage class or tier, if supplied by the backend.
    - `Encrypted` string — Encrypted entry name when using crypt remotes.
    - `EncryptedPath` string — Encrypted path when using crypt remotes.
    - `Metadata` object — Backend-provided metadata map.

## Other responses

- `202` — Request accepted for async processing. Poll /job/status with the returned jobid.
- `4XX` — Any error response (HTTP 4xx/5xx)
- `5XX` — Any error response (HTTP 4xx/5xx)

---

[API](https://skmtc.net/rclone/apis/rclone-rc-api.md) · [All operations](https://skmtc.net/rclone/apis/rclone-rc-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rclone/rclone-rc-api/versions/2849bf2803ce/schema)