# List objects

URL: https://docs.hanzo.ai/docs/openapi/s3/get-s3-buckets-by-bucket-objects

> Lists one folder level of a bucket.

`GET /v1/s3/buckets/{bucket}/objects`

> [S3 →](https://docs.hanzo.ai/docs/openapi/s3) · [All API references →](https://docs.hanzo.ai/docs/openapi) · [Get started →](https://docs.hanzo.ai/docs/guides)

|               |                                                       |
| ------------- | ----------------------------------------------------- |
| **Address**   | `https://api.hanzo.ai/v1/s3/buckets/{bucket}/objects` |
| **Method**    | `GET`                                                 |
| **Operation** | `get_s3_buckets_by_bucket_objects`                    |
| **Auth**      | `Authorization: Bearer $HANZO_API_KEY`                |

Lists one folder level of a bucket.

Folder-style by default: sub-prefixes come back as directory entries, which is
the file-manager view. `?recursive=true` lists every key flat under the prefix
instead. Keys are RELATIVE to `?prefix=`, and the listing is bounded so a huge
bucket cannot exhaust memory — Total is what came back, not what the bucket
holds.

Billed per call: the balance is checked BEFORE anything is touched, so an
unfunded org is refused with nothing read, and the debit lands only once the
listing has succeeded.

## Request

3 fields.

| Field       | In    | Type   | Required | Description                                  |
| ----------- | ----- | ------ | -------- | -------------------------------------------- |
| `bucket`    | path  | string | yes      | Bucket is the bucket to list, from the path. |
| `prefix`    | query | string | —        |                                              |
| `recursive` | query | string | —        |                                              |

## Response

| Status    | Body            | Meaning |
| --------- | --------------- | ------- |
| `200`     | s3.objectList   | ok      |
| `default` | problem-details | refused |

`200` body — 9 fields.

| Field                    | In   | Type             | Always | Description                                                                                                         |
| ------------------------ | ---- | ---------------- | ------ | ------------------------------------------------------------------------------------------------------------------- |
| `bucket`                 | body | string           | —      | Bucket is the bucket that was listed, friendly name.                                                                |
| `objects`                | body | s3.objectItem\[] | —      | Objects are the entries at this level, keys RELATIVE to Prefix.                                                     |
| `objects[].etag`         | body | string           | —      | ETag is the store's entity tag for the bytes currently at this key, with the quotes the store wraps it in stripped. |
| `objects[].isDir`        | body | boolean          | —      | true for a folder (common prefix)                                                                                   |
| `objects[].key`          | body | string           | —      | key RELATIVE to the requested prefix                                                                                |
| `objects[].lastModified` | body | integer (int64)  | —      | unix seconds (0 for a folder)                                                                                       |
| `objects[].size`         | body | integer (int64)  | —      | bytes (0 for a folder)                                                                                              |
| `prefix`                 | body | string           | —      | Prefix is the sub-folder the listing was scoped to, cleaned.                                                        |
| `total`                  | body | integer (int64)  | —      | Total is how many entries came back.                                                                                |

Failure carries the platform error shape — see [Errors](https://docs.hanzo.ai/docs/errors).

## Examples

**CLI**

```bash
hanzo s3 buckets objects get <bucket>
```

**SDK**

**.ts**

```ts
import { Configuration, S3Api } from 'hanzoai';

const api = new S3Api(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getS3BucketsByBucketObjects({ bucket: 'bucket' });
```

**.py**

```python
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import S3Api

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = S3Api(client).get_s3_buckets_by_bucket_objects(bucket='bucket')
```

**.go**

```go
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.S3API.GetS3BucketsByBucketObjects(context.Background()).Execute()
if err != nil {
	return err
}
```

**.rs**

```rust
use hanzo_client::apis::{configuration::Configuration, s3_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = s3_api::get_s3_buckets_by_bucket_objects(&cfg, Default::default()).await?;
```

**.java**

```java
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.S3Api;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new S3Api(client).getS3BucketsByBucketObjects();
```

**HTTP**

```bash
curl https://api.hanzo.ai/v1/s3/buckets/<bucket>/objects \
  -H "Authorization: Bearer $HANZO_API_KEY"
```

**MCP**

MCP reaches **s3** through the `s3` tool, which names its 6 operations with its own verbs — this one among them, under a name only MCP declares. `describe` explains any of them:

```bash
curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "describe",
         "arguments": {
           "op": "list_s3_buckets"
         }
       }
     }'
```

---

[S3 API](https://docs.hanzo.ai/docs/openapi/s3) · [All Hanzo APIs](https://docs.hanzo.ai/docs/openapi) · [Interactive reference](https://docs.hanzo.ai/docs/openapi/reference)