Documentation
API Reference
SDKs

Documentation
API Reference
SDKs

Documents
Search
- POSTsearch.content
- POSTsearch.documents
Buckets
Groups
Customer
- GETget
Health
- GETlist
- GETget

get

GET

Look up a specific bucket by its bucketId.

Path parameters

bucketIdintegerRequired

The bucketId of the bucket to look up.

Response

Look up success

bucketobject

Errors

GET

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

1 {
2   "bucket": {
3     "bucketId": 1,
4     "created": "2023-10-03T08:59:39Z",
5     "fileCount": 1,
6     "fileSize": "3.1GB",
7     "name": "name",
8     "updated": "2023-10-03T08:59:39Z"
9   }
10 }