list | Documentation

List all buckets within your GroundX account

Query parameters

nintegerOptional

The maximum number of returned buckets. Accepts 1-100 with a default of 20.

nextTokenstringOptional

A token for pagination. If the number of buckets for a given query is larger than n, the response will include a “nextToken” value. That token can be included in this field to retrieve the next batch of n buckets.

Response

Look up success

bucketslist of objectsOptional

countintegerOptional

The number of buckets returned in the current response

remainingintegerOptional

The number of buckets that have not been returned yet, will be null if there are no remaining buckets

totalintegerOptional

The total number of buckets found

1	from groundx import GroundX
2
3	client = GroundX(
4	api_key="YOUR_API_KEY",
5	)
6	client.buckets.list()

1	{
2	"buckets": [
3	{
4	"bucketId": 0,
5	"created": "2023-10-03T08:59:39.312Z",
6	"fileCount": 0,
7	"fileSize": "3.1GB",
8	"name": "name",
9	"updated": "2023-10-03T08:59:39.312Z"
10	}
11	],
12	"count": 0,
13	"remaining": 10,
14	"total": 30
15	}

Headers

Query parameters

Response