Skip to main content
A group is a collection of participants that shares its own balances and state. Groups are organization-level ledger entities with balances independent of any individual member, and they can participate across programs: balance operations take a program_id, but the group itself is not scoped to one program. Members hold a role of MEMBER or ADMIN, and a group must always keep at least one ADMIN. Removing a member soft-deletes the membership with a LEFT status and does not affect the group’s balance. Deleting a group archives it: archived groups drop out of listings unless include_archived=true and cannot be modified.

​
Endpoints

  • Create, list, get, update, and delete groups
  • Add and remove members with roles
  • Adjust, hold, release, and forfeit group balances per asset and program
  • Read and write group tags, counters, and attributes
  • Read the group’s state change history
For usage patterns and examples, see the Groups guide.