New to Corsair? See API access, authentication, and error handling.
Categories
list
categories.list
List expense categories with their subcategories; an expense must use a subcategory
Risk: read
categories full type
categories full type
Comments
create
comments.create
Post a comment on an expense
Risk: destructive
Output
comment full type
comment full type
delete
comments.delete
Delete a comment; this cannot be undone
Risk: destructive · Irreversible
A deleted comment cannot be restored.
Output
comment full type
comment full type
list
comments.list
List the comments on an expense
Risk: read
Output
comments full type
comments full type
Currencies
list
currencies.list
List the currency codes Splitwise accepts
Risk: read
currencies full type
currencies full type
Expenses
create
expenses.create
Record an expense, split either equally across a group or by an explicit paid and owed share per person
Risk: destructive
Pass either
split_equally: true with a group_id, or a users list whose paid and owed amounts add up to cost.
users full type
users full type
expenses full type
expenses full type
delete
expenses.delete
Delete an expense; it can be restored with expenses.undelete
Risk: destructive
Soft delete: the expense can be restored with
expenses.undelete.
Output
get
expenses.get
Get one expense with its shares, repayments and comments
Risk: read
Output
expense full type
expense full type
list
expenses.list
List the current user expenses, filtered by group, friend or date, with limit and offset paging
Risk: read
Output
expenses full type
expenses full type
undelete
expenses.undelete
Restore a deleted expense
Risk: write
Output
update
expenses.update
Change an expense; passing any share replaces every share on it
Risk: destructive
Passing
users replaces every share, so cost is required with it. Omitted fields stay as they were.
users full type
users full type
expenses full type
expenses full type
Friends
add
friends.add
Add a friend by email; a first name is needed when the person has no Splitwise account yet
Risk: destructive
Output
friend full type
friend full type
addMany
friends.addMany
Add several friends in one call, returning each result alongside any errors
Risk: destructive
users full type
users full type
users full type
users full type
delete
friends.delete
Break off the friendship; Splitwise keeps the expenses but the friend is removed from the list and there is no undelete call
Risk: destructive · Irreversible
There is no undelete call for a friendship.
Output
get
friends.get
Get one friend with their balances and shared groups
Risk: read
Output
friend full type
friend full type
list
friends.list
List the current user friends with the balance owed either way
Risk: read
friends full type
friends full type
Groups
addUser
groups.addUser
Add a Splitwise user, or a new person by name and email, to a group
Risk: destructive
Output
user full type
user full type
create
groups.create
Create a group and add members by user ID or by name and email; the current user is added automatically
Risk: destructive
Members are sent as
users__<index>__<property> keys. A member needs either user_id or email; add first_name and last_name for someone without an account.
users full type
users full type
group full type
group full type
delete
groups.delete
Delete a group and every expense in it; the group can be restored with groups.undelete
Risk: destructive
Deletes the group and every expense in it. The group can be restored with
groups.undelete.
Output
get
groups.get
Get one group with its members, balances and debts
Risk: read
Output
group full type
group full type
list
groups.list
List the current user groups with their members, balances and simplified debts; expenses outside a group appear as group 0
Risk: read
groups full type
groups full type
removeUser
groups.removeUser
Remove a user from a group; Splitwise refuses while that user has a non-zero balance
Risk: write
Splitwise refuses while the user has a non-zero balance.
Output
undelete
groups.undelete
Restore a deleted group
Risk: write
This route reports
errors as an array of strings rather than the map every other write uses.
Output
Notifications
list
notifications.list
List recent activity on the account, newest first, optionally after a given time
Risk: read
Omit
limit to get the provider maximum; Splitwise imposes its own cap on very old updated_after values.
Output
notifications full type
notifications full type
Users
get
users.get
Get another user by ID; Splitwise only answers for people you share a group or expense with
Risk: read
Splitwise only answers for people you share a group or an expense with; anyone else is a 403.
Output
user full type
user full type
getCurrentUser
users.getCurrentUser
Get the user the key belongs to, with its notification settings and unread count
Risk: read
user full type
user full type
update
users.update
Change a user’s name, email, password, locale or default currency
Risk: write
The ID travels in the path, so it cannot also be changed through the body.
Output
user full type
user full type