---
title: "list"
method: GET
path: "/v1/bucket"
tags: ["Buckets"]
---

# list

`GET /v1/bucket`

List all buckets within your GroundX account

Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.

## Query parameters

- `n` integer
- `nextToken` string

## Response `200`

Look up success

- BucketListResponse
  - `buckets` BucketDetail[]
    - `bucketId` integer, required
    - `created` string, date-time — The data time when the bucket was created, in RFC3339 format
    - `fileCount` integer — The number of files contained in the content bucket
    - `fileSize` string — The total file size of files contained in the content bucket
    - `name` string
    - `updated` string, date-time — The data time when the bucket was last updated, in RFC3339 format

## Changes

- **2023-11-29** `3bb565058636` — 2 info
  - added the new optional `query` request parameter `n`
  - added the new optional `query` request parameter `nextToken`
- **2023-11-29** `bf7061385e18` — 1 info
  - removed the non-success response with the status `401`
- **2023-10-13** `43657b55255e` — 2 info
  - added the optional property `buckets/items/created` to the response with the `200` status
  - added the optional property `buckets/items/updated` to the response with the `200` status
- **2023-10-05** `5ee59ea914aa` — 2 info
  - api tag `Buckets` added
  - api tag `Bucket` removed
- **2023-10-05** `006f5c1a8d40` — 1 info
  - the response property `buckets/items/bucketId` became required for the status `200`

[Full history](https://skmtc.dev/groundxai/apis/groundx-apis/changes/v1/bucket/get.md)

---

[API](https://skmtc.dev/groundxai/apis/groundx-apis.md) · [All operations](https://skmtc.dev/groundxai/apis/groundx-apis/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/groundxai/groundx-apis/revisions/1c1a5c17f52f/schema)