splitwise_get_group
Read one Splitwise group's members with balances, who owes whom, and invite link. Use it before settling up or to get a member's user ID.
Instructions
Read one group: its members with balances, who owes whom, and the invite link.
Calls GET /get_group/{id}. Members are rendered First Last (id N) with every
non-zero balance per currency. Debts are rendered A → B 12.50 USD (A owes B), names
resolved from the group's own members; the simplified debts are shown, or the
original debts (labelled as such) when Splitwise returned no simplified ones.
Sign convention for member balances: positive = that member is owed money; negative =
they owe. Group id 0 is the pseudo-group for non-group expenses.
When to Use:
To see who owes whom inside a group before settling up.
To get a member's user id before removing them or building expense shares.
To fetch the group's invite link.
When NOT to Use:
To list all your groups (use
splitwise_get_groups), or find one by name (splitwise_resolve_group).For the group's expenses (use
splitwise_get_expenseswith group_id).
Returns: A markdown block (name, type, settings, members, debts, invite link; members and debts capped at 50 each, with a note) or, with response_format=json, the raw group object.
Examples:
params = {"group_id": 12345}
params = {"group_id": 12345, "response_format": "json"}
Error Handling:
403 → you are not a member of that group; 404 → wrong id or the group was deleted
(see splitwise_undelete_group).
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| params | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |