list | Documentation

list all groups within your GroundX account.

Query parameters

nintegerOptional

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

nextTokenstringOptional

A token for pagination. If the number of groups 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 groups.

Response

Successful retrieval of groups

groupslist of objectsOptional

countintegerOptional

The number of groups returned in the current response

remainingintegerOptional

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

totalintegerOptional

The total number of groups found

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

1	{
2	"groups": [
3	{
4	"buckets": [
5	{
6	"bucketId": 0,
7	"created": "2023-10-03T08:59:39.312Z",
8	"fileCount": 0,
9	"fileSize": "3.1GB",
10	"name": "name",
11	"updated": "2023-10-03T08:59:39.312Z"
12	}
13	],
14	"created": "2023-10-03T08:59:39.312Z",
15	"fileCount": 0,
16	"fileSize": "3.1GB",
17	"groupId": 0,
18	"name": "name",
19	"updated": "2023-10-03T08:59:39.312Z"
20	}
21	],
22	"count": 0,
23	"remaining": 10,
24	"total": 30
25	}

Headers

Query parameters

Response