splitwise_get_friends
List Splitwise friends with per-currency balances and user IDs to see who owes whom or prepare shared expenses.
Instructions
List your Splitwise friends with their balance per currency.
Calls GET /get_friends. One row per friend: First Last (id N), e-mail,
registration status (confirmed | invited | dummy) and the overall balance per
currency. Sign convention: positive = they owe you; negative = you owe them.
JSON mode returns the raw friend objects, including groups[] with the balance
per shared group (group 0 = non-group expenses).
When to Use:
To see who owes you / whom you owe, per friend and currency.
To find a friend's user id before building expense shares or adding them to a group.
With
only_with_balance=trueto list only the friendships that are not settled up.
When NOT to Use:
To find a friend by a fuzzy name (use
splitwise_resolve_friend).For totals per currency across all friends (use
splitwise_get_balances).For one friend's detail incl. per-group balances (use
splitwise_get_friend).For balances inside one group (use
splitwise_get_group_balances).
Returns:
Markdown: a header with the sign convention and counts, then a table
(Friend | Email | Status | Balance), capped at 50 rows with a note when more exist.
JSON: {"count", "only_with_balance", "friends": [raw friend objects]}.
Examples:
All friends: params = {}
Only open balances: params = {"only_with_balance": true}
Raw objects with per-group balances: params = {"response_format": "json"}
Error Handling: 401 means the API key is missing or revoked (https://secure.splitwise.com/apps); 429 means back off and retry later.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| params | Yes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |