> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.eyelevel.ai/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.eyelevel.ai/_mcp/server.

# list

GET https://api.groundx.ai/api/v1/bucket

List all buckets within your GroundX account


Reference: https://docs.eyelevel.ai/reference/api-reference/buckets/list

## Authentication

- `X-API-Key` header (required) — API Key authentication via header

## Request

### Query parameters

- `n` (integer, optional) — The maximum number of returned buckets. Accepts 1-100 with a default of 20.
- `nextToken` (string, optional) — Pass nextToken from the previous response to get the next page of up to n buckets.

## Response

### 200

Lookup successful

- `buckets` (list of BucketDetail, optional)
- `count` (integer, optional) — The number of buckets returned in the current response
- `remaining` (integer, optional) — Number of buckets not yet returned, or null if none remain.
- `total` (integer, optional) — The total number of buckets found

## Types

### BucketDetail

- `bucketId` (integer, required)
- `fileAccess` (FileAccessPolicy, optional, nullable) — Settings saved on this bucket. Null means use the account settings. Omitted when file protection is disabled.
- `effectiveFileAccess` (EffectivePolicy, optional) — Settings GroundX uses after checking document, bucket and account values. The default temporary-link lifetime is 300 seconds. Storage credentials may expire sooner. Normal protected URLs require an API key and do not expire.
- `created` (string, optional) — The data time when the bucket was created, in RFC3339 format
- `fileCount` (integer, optional) — The number of files contained in the content bucket
- `fileSize` (string, optional) — The total file size of files contained in the content bucket
- `name` (string, optional)
- `updated` (string, optional) — The data time when the bucket was last updated, in RFC3339 format
- `fileAccessRevision` (integer, optional, deprecated) — Deprecated. Not needed and ignored when updating file-access settings.

### FileAccessPolicy

Controls access to normal file URLs and the maximum lifetime of temporary links. For each setting, use the document value first, then bucket, then account. If none is set, defaults are public access and a 300-second link lifetime. Normal file URLs do not expire.

- `mode` (enum, optional) — Public allows anyone with the URL to read the file. Protected requires the owning account's API key in X-API-Key.
  - Allowed values: `public`, `protected`
- `urlTtlSeconds` (integer, optional) — Maximum lifetime of a new temporary link, in seconds. Does not make normal file URLs expire.

### EffectivePolicy

Settings GroundX uses after checking document, bucket and account values. The default temporary-link lifetime is 300 seconds. Storage credentials may expire sooner. Normal protected URLs require an API key and do not expire.

- `mode` (enum, required)
  - Allowed values: `public`, `protected`
- `urlTtlSeconds` (integer, required)

## Examples

**Response**

```json
{
  "buckets": [
    {
      "bucketId": 1,
      "fileAccess": {
        "mode": "public",
        "urlTtlSeconds": 1
      },
      "effectiveFileAccess": {
        "mode": "public",
        "urlTtlSeconds": 1
      },
      "created": "2023-10-03T08:59:39.312Z",
      "fileCount": 1,
      "fileSize": "3.1GB",
      "name": "string",
      "updated": "2023-10-03T08:59:39.312Z",
      "fileAccessRevision": 1
    }
  ],
  "count": 1,
  "remaining": 10,
  "total": 30
}
```

**SDK Code**

```python
import requests

url = "https://api.groundx.ai/api/v1/bucket"

headers = {"X-API-Key": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.groundx.ai/api/v1/bucket';
const options = {method: 'GET', headers: {'X-API-Key': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.groundx.ai/api/v1/bucket"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.groundx.ai/api/v1/bucket")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.groundx.ai/api/v1/bucket")
  .header("X-API-Key", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.groundx.ai/api/v1/bucket', [
  'headers' => [
    'X-API-Key' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.groundx.ai/api/v1/bucket");
var request = new RestRequest(Method.GET);
request.AddHeader("X-API-Key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["X-API-Key": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.groundx.ai/api/v1/bucket")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```