Splitwise

Learn how to use Splitwise with Composio

Overview

SLUG: SPLITWISE

Description

Splitwise helps you split bills and expenses with friends and family.

Authentication Details

client_id
stringRequired
client_secret
stringRequired
full
stringDefaults to https://secure.splitwise.com/api/v3.0Required
oauth_redirect_uri
stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add
scopes
string

Connecting to Splitwise

Create an auth config

Use the dashboard to create an auth config for the Splitwise toolkit. This allows you to connect multiple Splitwise accounts to Composio for agents to use.

1

Select App

Navigate to Splitwise.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Splitwise Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using OAuth2

1from composio import Composio
2
3# Replace these with your actual values
4splitwise_auth_config_id = "ac_YOUR_SPLITWISE_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000" # UUID from database/application
6
7composio = Composio()
8
9
10def authenticate_toolkit(user_id: str, auth_config_id: str):
11 connection_request = composio.connected_accounts.initiate(
12 user_id=user_id,
13 auth_config_id=auth_config_id,
14 )
15
16 print(
17 f"Visit this URL to authenticate Splitwise: {connection_request.redirect_url}"
18 )
19
20 # This will wait for the auth flow to be completed
21 connection_request.wait_for_connection(timeout=15)
22 return connection_request.id
23
24
25connection_id = authenticate_toolkit(user_id, splitwise_auth_config_id)
26
27# You can also verify the connection status using:
28connected_account = composio.connected_accounts.get(connection_id)
29print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Splitwise toolkit’s playground

For code examples, see the Tool calling guide and Provider examples.

Tool List

Tool Name: Add Friend

Description

Tool to add a new friend to Splitwise. Use when you have the friend's email and name details ready.

Action Parameters

user_email
stringRequired
user_first_name
string
user_last_name
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Add User to Group

Description

Tool to add a user to a group. Use when you need to add an existing Splitwise user to a specific group. Note: 200 OK does not indicate success; always check the response 'success' field.

Action Parameters

group_id
integerRequired
user_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Comment

Description

Tool to create a comment on a specific expense. Use when you need to add a comment or note to an existing expense.

Action Parameters

content
stringRequired
expense_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Expense

Description

Tool to create a new Splitwise expense. Use when you need to record a payment or bill in a group or between users. Provide either split_equally or a custom users list for shares.

Action Parameters

category_id
integer
cost
stringRequired
currency_code
string
date
string
description
stringRequired
details
string
group_id
integerRequired
repeat_interval
string
split_equally
boolean
users
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Friends

Description

Tool to add multiple friends at once to Splitwise. Use when you need to add several friends in a single operation.

Action Parameters

users
arrayRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Group

Description

Tool to create a new group in Splitwise. Use when you need to create a group for tracking shared expenses. The current user is automatically added to the group. You can optionally add other members during creation.

Action Parameters

group_type
string
name
stringRequired
simplify_by_default
boolean
users
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Comment

Description

Tool to delete a comment by its ID. Use after confirming you have a valid comment ID.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Expense

Description

Tool to delete an existing expense by its ID. Use after confirming you have a valid expense ID.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Friend

Description

Tool to delete an existing friend by ID. Use when you need to remove a friend relationship by its user ID. Call after confirming the correct friend ID.

Action Parameters

friend_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Group

Description

Tool to delete a group and all associated records by its ID. Use when you need to permanently remove a group and its expenses. Call after confirming the correct group ID.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Categories

Description

Tool to retrieve expense categories. Use when you need to list available categories before creating an expense.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Comments

Description

Tool to retrieve all comments associated with a specific expense. Use when you need to view comments on an expense, including both system-generated updates and user-authored messages.

Action Parameters

expense_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Currencies

Description

Tool to retrieve a list of supported currencies. Use when you need to display or validate currency options.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Current User

Description

Tool to retrieve information about the current authenticated user. Use when you need profile details of the logged-in user.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Expense

Description

Tool to retrieve detailed information about a specific expense by ID. Use when you need to view expense details including participants, shares, and repayments.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Expenses

Description

Tool to list the current user's expenses from Splitwise account. Use when you need to view expenses with optional filters like date ranges, groups, or friends.

Action Parameters

dated_after
string
dated_before
string
friend_id
integer
group_id
integer
limit
integer
offset
integer
updated_after
string
updated_before
string
visible
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Friend Details

Description

Tool to retrieve detailed information about a specific friend. Use when you need to get profile details and balance information for a friend by their user ID.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Friends

Description

Tool to list current user's friends on Splitwise. Use when you need to view all friends, their balances, and shared groups.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Group Info

Description

Action to retrieve information about a group.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Groups

Description

Tool to retrieve all groups for the current authenticated user. Use when you need to list user's groups to see their debts or members.

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get User Information

Description

Tool to retrieve information about another user by their ID. Use when you need profile details of a specific user.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Remove User from Group

Description

Tool to remove a user from a group. Use when you need to remove a user from a specific group. Note: User must have a zero balance in the group for removal to succeed. 200 OK does not indicate success; always check the response 'success' field.

Action Parameters

group_id
integerRequired
user_id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Restore Deleted Expense

Description

Tool to restore a previously deleted expense and all its associated records. Use when you need to recover an expense that was deleted. Call after confirming the correct expense ID.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Restore Deleted Group

Description

Tool to restore a previously deleted group and all its associated records. Use when you need to recover a group that was deleted. Call after confirming the correct group ID.

Action Parameters

id
integerRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Expense

Description

Tool to update an existing Splitwise expense. Use when you need to modify expense details such as cost, description, or participant shares. Only include fields you want to change. Note that a 200 OK response does not guarantee success - check that the errors object is empty.

Action Parameters

category_id
integer
cost
string
currency_code
string
date
string
description
string
details
string
group_id
integer
id
integerRequired
repeat_interval
string
users
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update User

Description

Tool to update user account details including name, email, password, and preferences. Use when you need to modify the current user's profile information.

Action Parameters

default_currency
string
email
string
first_name
string
id
integerRequired
last_name
string
locale
string
password
string

Action Response

data
objectRequired
error
string
successful
booleanRequired