---
title: "List objects"
method: GET
path: "/bus/objects/{prefix}"
tags: ["bus"]
---

# List objects

`GET /bus/objects/{prefix}`

Lists objects with the specified prefix.

## Path parameters

- `prefix` string, required

## Query parameters

- `bucket` string, required — The name of the bucket.
- `delimiter` string — Path delimiter ("/" or empty)
- `limit` integer — Maximum number of objects to return
- `marker` string — Key to start listing from
- `sortby` string — Field to sort results by
- `sortdir` string — Sort direction (asc/desc)
- `substring` string — Filter objects by substring
- `slabencryptionkey` string — Encryption key for slabs

## Response `200`

Successfully listed objects

- object
  - `objects` Object[]
    - `metadata` ObjectUserMetadata — User-defined metadata about an object provided through X-Sia-Meta- headers
    - `bucket` string — The name of the bucket.
    - `etag` string — The ETag of the object
    - `health` number, float — The health of the object
    - `modTime` string, date-time — When the object was last modified
    - `key` string — The key of the object
    - `size` integer — The size of the object in bytes
    - `mimeType` string — The MIME type of the object
    - `encryptionKey` string — A key used to encrypt and decrypt data. The key is either a regular key (key) or a salted key (skey). The latter requires a seed to be used for encryption and decryption.
    - `slabs` SlabSlice[]
      - `slab` Slab — A slab of data to migrate
        - `health` number, float
        - `encryptionKey` string — The encryption key used to encrypt the slab's shards
        - `minShards` integer — The number of data shards the slab is split into
      - `offset` integer
      - `limit` integer
  - `hasMore` boolean — Whether there are more objects to fetch

## Other responses

- `400` — Malformed request
- `500` — Internal server error

## Changes

- **2025-01-23** `c38282599c5a` — 1 breaking, 1 info
  - the `objects/items/allOf[subschema #3]/slabs/items/slab/minShards` response's property type/format changed from `integer`/`uint8` to ``/`` for status `200`
  - added `#/components/schemas/RedundancySettingsMinShards, subschema #2` to the `objects/items/allOf[subschema #3]/slabs/items/slab/minShards` response property `allOf` list for the response status `200`
- **2024-12-18** `922f156353c9` — 1 breaking, 1 info
  - removed the media type `text/plain` for the response with the status `500`
  - api tag `bus` added
- **2024-12-17** `d5dec74bd45a` — 1 info
  - endpoint added
- **2024-12-09** `f062c35d8f47` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/siafoundation/apis/renterd-api/changes/bus/objects/:prefix/get.md)

---

[API](https://skmtc.dev/siafoundation/apis/renterd-api.md) · [All operations](https://skmtc.dev/siafoundation/apis/renterd-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/siafoundation/renterd-api/revisions/184a3d5207da/schema)