v1

latestOpenAPI 3.0.0Apache 2.02026-07-17263751.6 KB
Groups

list

list all groups within your GroundX account.

Interact with the "Request Body" below to explore the arguments of this function. Enter your GroundX API key to send a request directly from this web page. Select your language of choice to structure a code snippet based on your specified arguments.

get/v1/group

Query parameters

ninteger

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

nextTokenstring

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

Example response

{
  "groups": [
    {
      "buckets": [
        {
          "created": "2023-10-03T08:59:39.312Z",
          "fileSize": "3.1GB",
          "updated": "2023-10-03T08:59:39.312Z"
        }
      ],
      "created": "2023-10-03T08:59:39.312Z",
      "fileSize": "3.1GB",
      "updated": "2023-10-03T08:59:39.312Z"
    }
  ]
}