Skip to main content
GET
Get group balances
Returns all balances for a group, one entry per asset with asset_id and the total balance. Groups are organization-level entities that hold balances per program-asset pair, so use the optional program_id query parameter to filter to a specific program. Group balances track the same three buckets as participant balances: available, held, and deferred. To move balance between buckets, use the hold, release, and forfeit endpoints.
For usage patterns and examples, see the Balance Operations guide.

Authorizations

X-API-Key
string
header
required

API key passed in the X-API-Key header.

Path Parameters

id
string<uuid>
required

Group ID

Query Parameters

program_id
string<uuid>

Filter by program ID

Response

Group balances

data
object[]

Asset balance entries

pagination
object

Pagination metadata for list responses