Skip to navigation
Buckets

list

List all buckets within your GroundX account

Authentication

X-API-Keystring
API Key authentication via header

Query parameters

nintegerOptional

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

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

Response

Lookup successful
bucketslist of objectsOptional
countintegerOptional
The number of buckets returned in the current response
remainingintegerOptional
Number of buckets not yet returned, or null if none remain.
totalintegerOptional
The total number of buckets found