list

GET

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

get

Up Next

Built with

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	"groupId": 1,
5	"buckets": [
6	{
7	"bucketId": 1,
8	"created": "2023-10-03T08:59:39Z",
9	"fileSize": "3.1GB",
10	"updated": "2023-10-03T08:59:39Z"
11	}
12	],
13	"created": "2023-10-03T08:59:39Z",
14	"fileCount": 1,
15	"fileSize": "3.1GB",
16	"name": "name",
17	"updated": "2023-10-03T08:59:39Z"
18	}
19	]
20	}