Groups

list

list all groups within your GroundX account.

Headers

X-API-KeystringRequired

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 objects or null
countinteger or null
The number of groups returned in the current response
remaininginteger or null
The number of groups that have not been returned yet, will be null if there are no remaining groups
totalinteger or null
The total number of groups found