> 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/group

list all groups within your GroundX account.


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

## Authentication

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

## Request

### Query parameters

- `n` (integer, optional) — The maximum number of returned groups. 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 groups.

## Response

### 200

Successful retrieval of groups

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

## Types

### GroupDetail

- `groupId` (integer, required)
- `buckets` (list of BucketDetail, optional) — The content buckets associated with the group
- `created` (string, optional) — The data time when the group was created, in RFC3339 format
- `fileCount` (integer, optional) — The number of files contained in the content buckets associated with the group
- `fileSize` (string, optional) — The total file size of files contained in the content buckets associated with the group
- `name` (string, optional)
- `prompt` (string, optional) — The group chat prompt stored in settings, when configured.
- `updated` (string, optional) — The data time when the group was last updated, in RFC3339 format

### BucketDetail

- `bucketId` (integer, required)
- `fileAccess` (FileAccessPolicy, optional, nullable) — Applied settings for this resource. Null means it inherits settings. Deployments without file access omit this field. Pending changes are not returned.
- `effectiveFileAccess` (EffectivePolicy, optional) — Applied settings after inheritance. Sharing links expire after 300 seconds by default; storage credentials may shorten that time. Protected stable URLs require current authentication on every read.
- `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) — Legacy compatibility field. Not required or checked when changing file access.

### FileAccessPolicy

For each field, document settings take priority over bucket settings, then account settings. Omitted fields use the broader value. Explicit public mode and longer sharing lifetimes are allowed. Stable public links never expire. urlTtlSeconds limits new sharing links; an issued link works without API credentials until its storage expiry.

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

### EffectivePolicy

Applied settings after inheritance. Sharing links expire after 300 seconds by default; storage credentials may shorten that time. Protected stable URLs require current authentication on every read.

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

## Examples

**Response**

```json
{
  "groups": [
    {
      "groupId": 1,
      "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
        }
      ],
      "created": "2023-10-03T08:59:39.312Z",
      "fileCount": 1,
      "fileSize": "3.1GB",
      "name": "string",
      "prompt": "string",
      "updated": "2023-10-03T08:59:39.312Z"
    }
  ],
  "count": 1,
  "remaining": 10,
  "total": 30
}
```

**SDK Code**

```python
import requests

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

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

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

print(response.json())
```

```javascript
const url = 'https://api.groundx.ai/api/v1/group';
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/group"

	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/group")

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/group")
  .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/group', [
  'headers' => [
    'X-API-Key' => '<apiKey>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.groundx.ai/api/v1/group");
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/group")! 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()
```