list

GET

https://api.groundx.ai/api/v1/group

GET

/api/v1/group

from groundx import GroundX
client = GroundX(
    api_key="YOUR_API_KEY_HERE",
)
client.groups.list()

200Retrieved

{
  "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",
      "updated": "2023-10-03T08:59:39.312Z"
    }
  ],
  "count": 1,
  "remaining": 10,
  "total": 30
}

list all groups within your GroundX account.

Authentication

X-API-Keystring

API Key authentication via header

Query parameters

nintegerOptional

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

nextTokenstringOptional

Pass nextToken from the previous response to get the next page of up to n groups.

Response

Successful retrieval of groups

groupslist of objectsOptional

countintegerOptional

The number of groups returned in the current response

remainingintegerOptional

Number of groups not yet returned, or null if none remain.

totalintegerOptional

The total number of groups found