Splitwise API (3.0.0)

Download OpenAPI specification:

Introduction

Hey there! We're glad you're interested in the Splitwise API. This documentation will help you to fetch information on users, expenses, groups, and much more.

If something in the API is confusing you, you can open an issue about it on GitHub. We're a small team, so we may not have an instant fix, but we'll get back to you as soon as we're able. (If you spot an issue in our API documentation itself, feel free to open a pull request to update this website!)

Third-Party SDKs

The development community has built a number of unofficial, third-party SDKs for Splitwise in a variety of different languages.

If you've built a third-party SDK for Splitwise and you'd like to see it included in this list, then please open a pull request to update this section and add a new link. Thank you for your work!

Note: These links are provided for convenience. These libraries have not been reviewed or endorsed by Splitwise, and Splitwise cannot vouch for their quality. If you have questions or bug reports, please direct your feedback to the authors of these libraries.

Terms of Use

Overview

Splitwise provides this Self-Serve API to facilitate integrations with third-party applications, as well as open-up functionality for hobbyists and power users to programmatically interact with their own Splitwise account and build plugins or other tools.

If you’re interested in integrating your commercial application with Splitwise, we strongly encourage you to contact developers@splitwise.com so our development team can help discuss your use case, provide private APIs and Enterprise support, and offer an appropriate commercial license for the integration. The Self-Serve API documented here may be suitable for internal prototyping and other exploratory work.

If you are developing a non-commercial plugin application or personal project, we recommend you make use of the Self-Serve API documented here under the API Terms Of Use. Please be aware that our Self-Serve API has conservative rate and access limits, which are subject to change at any time and not well suited to commercial projects. If this is a problem for your use case, please contact us at developers@splitwise.com to discuss your needs.

All Self-Service API users are subject to the API Terms of Use below.

TERMS OF USE

These API Terms of Use describe your rights and responsibilities when accessing our publicly available Application Programming Interface (API) and related API documentation. Please review them carefully.

Splitwise may modify this Agreement at any time by posting a revised version on our website. The revised version will be effective at the time that it is posted.

These API terms form a binding contract between you and us. In these terms "you," and "your," refers to the individual, company or legal entity and/or entities that you represent while accessing the API. “We”, “us”, “our” and “Splitwise” refers to Splitwise Inc. By accepting these API terms, either by accessing or using the API, or authorizing or permitting any individual to access or use the API, you agree to be bound by this contract.

  1. API License:
    1. Subject to the restrictions in these terms, we grant you a non-exclusive, revocable, worldwide, non-transferable, non-sublicensable, limited license to access and use (i) our APIs (ii) related API documentation, packages, sample code, software, or materials made available by Splitwise (“API Documentation”), and (iii) any and all access keys or data derived or obtained from Splitwise API responses (“Splitwise Data”). The Splitwise API, Splitwise Data, and API Documentation will be together referred to as the “Splitwise Materials.” You will use Splitwise Materials solely as necessary to develop, test and support a Self-Service integration of your software application (an "Application" or "App") with Splitwise in accordance with this Agreement and any other agreements between You and Splitwise.
  2. API License Restrictions
    1. You agree that will you will not, and will not allow any of your partners, subsidiaries and/or affiliates and each of their respective directors, officers, employees, agents, partners, suppliers, service providers, contractors or end users (collectively, “Your Affiliates”) to engage in any Prohibited Activities set forth in section 2f.
    2. Splitwise reserves the right to block or revoke, with or without notice, your access to any or all of the Splitwise Materials if Splitwise determines in its sole discretion that you are engaging in any of the Prohibited Activities.
    3. Splitwise may monitor your use of Splitwise Materials to improve our services and ensure compliance with this agreement, and may suspend your access to Splitwise Materials if we believe you are in violation.
    4. Your use of the Splitwise API is subject to usage limits and other functional restrictions in the sole discretion of Splitwise. You will not use the API in a manner that exceeds rate limits, or constitutes excessive or abusive usage.
    5. Your use of Splitwise Materials must respect Splitwise user’s privacy choices and settings and the Privacy portion of this agreement. You will obtain explicit consent from end users as a basis for any processing of Splitwise Materials. Your use of Splitwise Materials must comply with all Applicable Data Protection Laws applicable to you, including but not limited to GDPR and CCPA compliance.
    6. Prohibited Activities:
      1. You will not use Splitwise Materials or any part thereof in any manner or for any purpose that violates any law or regulation, or any right of any person, including but not limited to intellectual property rights, rights of privacy and/or publicity, or which otherwise results in liability to Splitwise, or its officers, employees, or end users.
      2. You will not use Splitwise Materials in a way that poses a security, operational or technical risk to our Services.
      3. You may not Splitwise Materials to create an application that replicates existing Splitwise functionality or competes with Splitwise and our Services.
      4. You will not use Splitwise Materials to create an application that encourages or creates functionality for users to violate our Terms of Service.
      5. You will not use Splitwise Materials to create an application that can be used by anyone under the age of 13. You will not knowingly collect or enable the collection of any personal information from children under the age of 13.
      6. You will not reverse engineer, decompile, disassemble, or otherwise attempt to derive the source code or underlying ideas, trade secrets, algorithms or structure of the Splitwise Materials, or Splitwise software applications.
      7. You will not attempt to defeat, avoid, bypass, remove, deactivate or otherwise circumvent any software protection mechanisms in the Splitwise Materials or Application or any part thereof, including without limitation, any such mechanism used to restrict or control the functionality of the API.
      8. You will not use Splitwise’s name to endorse or promote any product, including a product derived from Splitwise Materials.
      9. You will not sell, lease, rent, sublicense or in any way otherwise commercialize any Splitwise Data, or dataset derived from Splitwise Data and/or Splitwise Materials.
      10. You will not use Splitwise Materials in applications that send unsolicited communications to users or include any malware, adware, potentially unwanted programs, or similar applications that could damage or disparage Splitwise’s reputation or services.
  3. Privacy
    1. Your Application shall have a lawful privacy policy, accessible with reasonably prominent hyperlinks that does not conflict with or supersede the Splitwise Privacy Policy and that explains how you collect, store, use, and/or transfer any Personal Data via your Applications. Personal Data is data that may be used, either alone or together with other information, to identify an individual user, including, without limitation, a user’s name, address, telephone number, username, email address, city and country, geolocation, unique identifiers, picture, or other similar information and includes personal data as defined in the GDPR.
    2. You are responsible for maintaining an appropriate legal basis to process any data under all applicable data protection laws (including but not limited to the GDPR, and the CCPA).
    3. You will use industry standard security measures to protect against and prevent security breaches and any unauthorized disclosure of any personal information you process, including administrative, physical and technical safeguards for protection of the security, confidentiality and integrity of that personal information.
    4. You must promptly notify us in writing via email to security@splitwise.com of any security deficiencies in, or intrusions to, your Applications or systems that you discover, and of any breaches of your user agreement or privacy policy that impact or may impact Splitwise customers. Please review our Privacy Policy for more information on how we collect and use data relating to the use and performance of our Service.
    5. You will delete Splitwise Data as requested within a reasonable time, if so requested by either a Splitwise User or Splitwise Inc.
    6. Any data submitted to Splitwise through your use of the Splitwise API will be governed by the Splitwise Privacy Policy.
    7. You agree that Splitwise may collect certain use data and information related to your use of the Splitwise Materials, and the Splitwise API in connection with your Application (“Usage Data”), and that Splitwise may use such Usage Data for any business purpose, internal or external, including, without limitation, providing enhancements to the Splitwise Materials or Splitwise Platform, providing developer of user support, or otherwise. You agree to include a statement to this effect in your Application’s Privacy Policy.
  4. Conditions Of Use
    1. Splitwise reserves the right to modify our API at any time, for any reason, without notice.
    2. Splitwise may use your name, and other contact details to contact you regarding your use of our API or, if we believe you are in violation of this contract.
    3. You are solely responsible for your use of the Splitwise API and any application you create that uses Splitwise Materials, including but not limited to Customer Support.
    4. Splitwise reserves the right to develop and extend its products and capabilities without regard to whether those products compete with or invalidate your Splitwise integration or products offered by you.
    5. Splitwise may limit (i) the number of network calls that your App may make via the API; and (ii) the maximum number of Splitwise users that may connect your Application, or (iii) anything else about the Splitwise API as Splitwise deems appropriate, at Splitwise’s sole discretion.
    6. Splitwise may impose or modify these limitations without notice. Splitwise may utilize technical measures to prevent over-usage and stop usage of the API by your App after any usage limitations are exceeded or suspend your access to the API with or without notice to you in the event you exceed such limitations.
    7. You will not issue any press release or other announcement regarding your Application that makes any reference to Splitwise without our prior written consent.
    8. You will not use our API to distribute unsolicited advertising or promotions, or to send messages, make comments, or initiate any other unsolicited direct communication or contact with Splitwise users or partners.
  5. Use of Splitwise Marks
    1. The rights granted in this Agreement do not include any general right to use the Splitwise name or any Splitwise trademarks, service marks or logos (the “Splitwise Marks”) with respect to your Applications. Subject to your continued compliance with this Agreement, you may use Splitwise Marks for limited purposes related to your Applications only as described in Splitwise Branding Guidelines and/or as provided in written communications with the Splitwise team.
    2. These rights apply on a non-exclusive, non-transferable, worldwide, royalty-free basis, without any right to sub-license, and may be revoked by Splitwise at any time.
    3. If Splitwise updates Branding Guidelines or any Splitwise Marks that you are using, you agree to update such Splitwise Marks to reflect the most current versions. You must not use any Splitwise Marks or trade dress, or any confusingly similar mark or trade dress, as the name or part of the name, user interface, or icon of your Applications, or as part of any logo or branding for your Applications.
  6. Reservation Of Rights. The Splitwise Materials as well as the trademarks, copyrights, trade secrets, patents or other intellectual property (collectively, “Intellectual Property”) contained therein will remain the sole and exclusive property of Splitwise, and you will reasonably assist Splitwise in protecting such ownership. Splitwise reserves to itself all rights to the Splitwise Materials not expressly granted to You. Except as expressly provided in this Agreement, You do not acquire any rights to or interest in the Intellectual Property. You will not utilize Splitwise Intellectual Property except as expressly authorized under this Agreement.
  7. Feedback. Splitwise welcomes feedback from developers to improve our API, documentation and Services, and may provide feedback to you as well. We will review any feedback received, however we make no guarantee that suggestions will be implemented. If you choose to provide feedback, suggestions or comments regarding the Splitwise API, documentation, or services, you acknowledge that Splitwise will be free to use your feedback in any way it sees fit. This includes the freedom to copy, modify, create derivative works, distribute, publicly display, publicly perform, grant sublicenses to, and otherwise exploit in any manner such feedback, suggestions or comments, for any and all purposes, with no obligation of any kind to you, in perpetuity.
  8. Confidentiality. Any information not generally available to the public that is made available to you should be considered Confidential. You agree to:
    1. Protect this information from unauthorized use, access, or disclosure,
    2. Use this information only as necessary,
    3. Destroy any copies, or return this information to us when this Contract is terminated, or at any time as requested by Splitwise
  9. Termination. This Contract shall remain effective until terminated by either party. You may terminate this Contract at any time, by discontinuing your use of our APIs. Splitwise may terminate this Contract at any time with or without cause and without advanced notice to you. Upon termination, all rights and licenses granted under this Contract shall immediately terminate. You must immediately discontinue any use, and destroy any copies of the Splitwise Materials and Confidential Information in your possession.
  10. Representations and Warranties. You represent and warrant that you have validly entered into the Contract, and that you have the legal power to do so, and that doing so will not violate any law, government regulation, or breach agreement with another third party.

    THE SPLITWISE API AND DOCUMENTATION IS BEING PROVIDED TO YOU ‘AS IS’ AND ‘AS AVAILABLE’ WITHOUT ANY WARRANTIES OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY WARRANTIES OF MERCHANTABILITY, TITLE, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT. YOU ACKNOWLEDGE THAT WE DO NOT WARRANT THAT THE APIS WILL BE UNINTERRUPTED, TIMELY, SECURE, OR ERROR-FREE.
  11. Limitation of Liability.

    TO THE MAXIMUM EXTENT PERMITTED BY LAW, IN NO EVENT SHALL SPLITWISE, ITS AFFILIATES, OFFICERS, DIRECTORS, EMPLOYEES, AGENTS, LICENSORS, LICENSEES, ASSIGNS OR SUCCESSORS BE LIABLE TO YOU OR ANY THIRD PARTY FOR ANY INDIRECT, INCIDENTAL, SPECIAL, PUNITIVE OR CONSEQUENTIAL DAMAGES (INCLUDING BUT NOT LIMITED TO ANY LOSS OF DATA, SERVICE INTERRUPTION, COMPUTER FAILURE, OR PECUNIARY LOSS) HOWEVER CAUSED, WHETHER IN CONTRACT, TORT OR UNDER ANY OTHER THEORY OF LIABILITY, AND WHETHER OR NOT YOU OR THE THIRD PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. YOUR ONLY RIGHT WITH RESPECT TO ANY PROBLEMS OR DISSATISFACTION WITH THE SPLITWISE SERVICES IS TO STOP USING THE SPLITWISE SERVICES.

    SOME JURISDICTIONS DO NOT ALLOW THE LIMITATION OR EXCLUSION OF LIABILITY FOR CERTAIN TYPES OF DAMAGES REFERRED TO ABOVE (INCLUDING INCIDENTAL OR CONSEQUENTIAL DAMAGES). ACCORDINGLY, SOME OF THE ABOVE LIMITATIONS AND EXCLUSIONS MAY NOT APPLY TO YOU. YOU AGREE THAT SPLITWISE’S AGGREGATE LIABILITY UNDER THIS AGREEMENT IS LIMITED TO ONE HUNDRED DOLLARS ($100).
  12. Indemnification: You agree to defend, indemnify, and hold harmless Splitwise and its affiliates, directors, and customers, from and against any and all third-party claims, actions, suits, and proceedings (including, but not limited to legal, or investigative fees), arising out of, or related to your use of the Splitwise Services, your violation of this Contract, your violation of your user agreement or privacy policy, or your violation of any laws, regulations, or third party rights.
  13. Miscellaneous
    1. Applicable Law, Jurisdiction, and Venue: Any dispute arising out of this Agreement shall be governed by Massachusetts law and controlling U.S. federal law, without regard to conflict of law provisions thereof. Any claim or dispute between you and Splitwise that arises in whole or in part from this Contract or your use of the API or our Services shall be decided exclusively by a court of competent jurisdiction located in Massachusetts, and you hereby consent to, and waive all defenses of lack of personal jurisdiction and forum non conveniens with respect to venue and jurisdiction in the state and federal courts of Massachusetts.
    2. Assignment: You may not assign or delegate any of your rights or obligations hereunder, whether by operation of law or otherwise, without Splitwise’s prior written consent. Splitwise retains the right to assign the Contract in its entirety, without consent of the other party, to a corporate affiliate or in connection with a merger, acquisition, corporate reorganization, or sale of all or substantially all of its assets. Any purported assignment in violation of this section is void.
    3. Language: This contact was drafted in English. In the event that this contract, or any part thereof, is translated to a language other than English, the English-language version shall control in the event of a conflict.
    4. Relationship: You and Splitwise are independent contractors. This Contract does not create or imply any partnership, agency, joint venture, fiduciary or employment relationship between the parties. There are no third party beneficiaries to the Contract.
    5. Severability: The Contract will be enforced to the fullest extent permitted under applicable law. If any provision of the Contract is found to be invalid or unenforceable by a court of competent jurisdiction, the provision will be modified by the court and interpreted so as best to accomplish the objectives of the original provision to the fullest extent permitted by law, and the remaining provisions of the Contract will remain in effect.
    6. Force Majeure: Neither we nor you will be responsible for any failure to perform obligations under this Contract if such failure is caused by events beyond the reasonable control of a party, which may include denial-of-service attacks, a failure by a third party hosting provider, acts of God, war, strikes, revolutions, lack or failure of transportation facilities, laws or governmental regulations.
    7. Entire Agreement: These Terms comprise the entire agreement between you and Splitwise with respect to the above subject matter and supersedes and merges all prior proposals, understandings and contemporaneous communications.

Users

Resources to access and modify user information.

Get information about the current user

Authorizations:
OAuthApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "user": {
    }
}

Get information about another user

Authorizations:
OAuthApiKeyAuth
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "user": {
    }
}

Update a user

Authorizations:
OAuthApiKeyAuth
path Parameters
id
required
integer
Request Body schema: application/json
required
first_name
string
last_name
string
email
string
password
string
locale
string
default_currency
string

Responses

Request samples

Content type
application/json
{
  • "first_name": "string",
  • "last_name": "string",
  • "email": "string",
  • "password": "string",
  • "locale": "string",
  • "default_currency": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "first_name": "Ada",
  • "last_name": "Lovelace",
  • "email": "ada@example.com",
  • "registration_status": "confirmed",
  • "picture": {
    },
  • "custom_picture": false
}

Groups

A Group represents a collection of users who share expenses together. For example, some users use a Group to aggregate expenses related to a home. Others use it to represent a trip. Expenses assigned to a group are split among the users of that group. Importantly, two users in a Group can also have expenses with one another outside of the Group.

List the current user's groups

Note: Expenses that are not associated with a group are listed in a group with ID 0.

Authorizations:
OAuthApiKeyAuth

Responses

Response samples

Content type
application/json
{}

Get information about a group

Authorizations:
OAuthApiKeyAuth
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{}

Create a group

Creates a new group. Adds the current user to the group by default.

Note: group user parameters must be flattened into the format users__{index}__{property}, where property is user_id, first_name, last_name, or email. The user's email or ID must be provided.

Authorizations:
OAuthApiKeyAuth
Request Body schema: application/json
required
name
required
string
group_type
string
Enum: "home" "trip" "couple" "other" "apartment" "house"

What is the group used for?

Note: It is recommended to use home in place of house or apartment.

simplify_by_default
boolean

Turn on simplify debts?

users__{index}__{property}*
additional property
string

Responses

Request samples

Content type
application/json
{
  • "name": "The Brain Trust",
  • "group_type": "trip",
  • "users__0__first_name": "Alan",
  • "users__0__last_name": "Turing",
  • "users__0__email": "alan@example.org",
  • "users__1__id": 5823
}

Response samples

Content type
application/json
{}

Delete a group

Delete an existing group. Destroys all associated records (expenses, etc.)

Authorizations:
OAuthApiKeyAuth
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Restore a group

Restores a deleted group.

Note: 200 OK does not indicate a successful response. You must check the success value of the response.

Authorizations:
OAuthApiKeyAuth
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
Example
{
  • "success": true
}

Add a user to a group

Note: 200 OK does not indicate a successful response. You must check the success value of the response.

Authorizations:
OAuthApiKeyAuth
Request Body schema: application/json
required
One of
group_id
required
integer
user_id
required
integer

Responses

Request samples

Content type
application/json
Example
{
  • "group_id": 49012,
  • "user_id": 7999632
}

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "user": { },
  • "errors": { }
}

Remove a user from a group

Remove a user from a group. Does not succeed if the user has a non-zero balance.

Note: 200 OK does not indicate a successful response. You must check the success value of the response.

Authorizations:
OAuthApiKeyAuth
Request Body schema: application/json
required
group_id
required
integer
user_id
required
integer

Responses

Request samples

Content type
application/json
{
  • "group_id": 4012,
  • "user_id": 940142
}

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "errors": { }
}

Friends

List current user's friends

Note: group objects only include group balances with that friend.

Authorizations:
OAuthApiKeyAuth

Responses

Response samples

Content type
application/json
{
  • "friends": [
    ]
}

Get details about a friend

Authorizations:
OAuthApiKeyAuth
path Parameters
id
required
integer

User ID of the friend

Responses

Response samples

Content type
application/json
{
  • "friend": {
    }
}

Add a friend

Adds a friend. If the other user does not exist, you must supply user_first_name. If the other user exists, user_first_name and user_last_name will be ignored.

Authorizations:
OAuthApiKeyAuth
Request Body schema: application/json
required
user_email
string
user_first_name
string
user_last_name
string

Responses

Request samples

Content type
application/json
{
  • "user_email": "ada@example.com",
  • "user_first_name": "Ada",
  • "user_last_name": "Lovelace"
}

Response samples

Content type
application/json
{
  • "friend": {
    }
}

Add friends

Add multiple friends at once.

For each user, if the other user does not exist, you must supply friends__{index}__first_name.

Note: user parameters must be flattened into the format friends__{index}__{property}, where property is first_name, last_name, or email.

Authorizations:
OAuthApiKeyAuth
Request Body schema: application/json
required
friends__{index}__{property}*
additional property
string

Responses

Request samples

Content type
application/json
{
  • "friends__0__first_name": "Alan",
  • "friends__0__last_name": "Turing",
  • "friends__0__email": "alan@example.org",
  • "friends__1__email": "existing_user@example.com"
}

Response samples

Content type
application/json
{
  • "users": [
    ],
  • "errors": {
    }
}

Delete friendship

Given a friend ID, break off the friendship between the current user and the specified user.

Note: 200 OK does not indicate a successful response. You must check the success value of the response.

Authorizations:
OAuthApiKeyAuth
path Parameters
id
required
integer

User ID of the friend

Responses

Response samples

Content type
application/json
Example
{
  • "success": true,
  • "errors": [ ]
}

Expenses

Get expense information

Authorizations:
OAuthApiKeyAuth
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "expense": {
    }
}

List the current user's expenses

Authorizations:
OAuthApiKeyAuth
query Parameters
group_id
integer

If provided, only expenses in that group will be returned, and friend_id will be ignored.

friend_id
integer

ID of another user. If provided, only expenses between the current and provided user will be returned.

dated_after
string <date-time>
dated_before
string <date-time>
updated_after
string <update-time>
updated_before
string <date-time>
limit
integer
Default: 20
offset
integer
Default: 0

Responses

Response samples

Content type
application/json
{
  • "expenses": [
    ]
}

Create an expense

Creates an expense. You may either split an expense equally (only with group_id provided), or supply a list of shares.

When splitting equally, the authenticated user is assumed to be the payer.

When providing a list of shares, each share must include paid_share and owed_share, and must be identified by one of the following:

  • email, first_name, and last_name
  • user_id

Note: 200 OK does not indicate a successful response. The operation was successful only if errors is empty.

Authorizations:
OAuthApiKeyAuth
Request Body schema: application/json
required
One of
cost
required
string

A string representation of a decimal value, limited to 2 decimal places

description
required
string

A short description of the expense

details
string or null

Also known as "notes."

date
string <date-time>

The date and time the expense took place. May differ from created_at

repeat_interval
string
Enum: "never" "weekly" "fortnightly" "monthly" "yearly"
currency_code
string

A currency code. Must be in the list from get_currencies

category_id
integer

A category id from get_categories

group_id
required
integer

The group to put this expense in.

split_equally
required
boolean
Value: true

Responses

Request samples

Content type
application/json
Example
{
  • "cost": "25",
  • "description": "Grocery run",
  • "details": "string",
  • "date": "2012-05-02T13:00:00Z",
  • "repeat_interval": "never",
  • "currency_code": "USD",
  • "category_id": 15,
  • "group_id": 0,
  • "split_equally": true
}

Response samples

Content type
application/json
{
  • "expenses": [
    ],
  • "errors": { }
}

Update an expense

Updates an expense. Parameters are the same as in create_expense, but you only need to include parameters that are changing from the previous values. If any values is supplied for users__{index}__{property}, all shares for the expense will be overwritten with the provided values.

Note: 200 OK does not indicate a successful response. The operation was successful only if errors is empty.

Authorizations:
OAuthApiKeyAuth
path Parameters
id
required
integer

ID of the expense to update

Request Body schema: application/json
required
cost
required
string

A string representation of a decimal value, limited to 2 decimal places

description
required
string

A short description of the expense

details
string or null

Also known as "notes."

date
string <date-time>

The date and time the expense took place. May differ from created_at

repeat_interval
string
Enum: "never" "weekly" "fortnightly" "monthly" "yearly"
currency_code
string

A currency code. Must be in the list from get_currencies

category_id
integer

A category id from get_categories

group_id
required
integer

The group to put this expense in, or 0 to create an expense outside of a group.

users__0__user_id
integer
users__0__paid_share
string

Decimal amount as a string with 2 decimal places. The amount this user paid for the expense

users__0__owed_share
string

Decimal amount as a string with 2 decimal places. The amount this user owes for the expense

users__1__first_name
string
users__1__last_name
string
users__1__email
string
users__1__paid_share
string

Decimal amount as a string with 2 decimal places. The amount this user paid for the expense

users__1__owed_share
string

Decimal amount as a string with 2 decimal places. The amount this user owes for the expense

users__{index}__{property}*
additional property
string

Responses

Request samples

Content type
application/json
{
  • "cost": "25",
  • "description": "Grocery run",
  • "details": "string",
  • "date": "2012-05-02T13:00:00Z",
  • "repeat_interval": "never",
  • "currency_code": "USD",
  • "category_id": 15,
  • "group_id": 0,
  • "users__0__user_id": 54123,
  • "users__0__paid_share": "25",
  • "users__0__owed_share": "13.55",
  • "users__1__first_name": "Neu",
  • "users__1__last_name": "Yewzer",
  • "users__1__email": "neuyewxyz@example.com",
  • "users__1__paid_share": "0",
  • "users__1__owed_share": "11.45",
  • "users__{index}__{property}1": "string",
  • "users__{index}__{property}2": "string"
}

Response samples

Content type
application/json
{
  • "expenses": [
    ],
  • "errors": { }
}

Delete an expense

Note: 200 OK does not indicate a successful response. The operation was successful only if success is true.

Authorizations:
OAuthApiKeyAuth
path Parameters
id
required
integer

ID of the expense to delete

Responses

Response samples

Content type
application/json
Example
{
  • "success": true
}

Restore an expense

Note: 200 OK does not indicate a successful response. The operation was successful only if success is true.

Authorizations:
OAuthApiKeyAuth
path Parameters
id
required
integer

ID of the expense to restore

Responses

Response samples

Content type
application/json
{
  • "success": true
}

Comments

Get expense comments

Authorizations:
OAuthApiKeyAuth
query Parameters
expense_id
required
integer
Example: expense_id=4193

Responses

Response samples

Content type
application/json
{
  • "comments": [
    ]
}

Create a comment

Authorizations:
OAuthApiKeyAuth
Request Body schema: application/json
required
expense_id
integer
content
string

Responses

Request samples

Content type
application/json
{
  • "expense_id": 5123,
  • "content": "Does this include the delivery fee?"
}

Response samples

Content type
application/json
{
  • "comment": {
    }
}

Delete a comment

Deletes a comment. Returns the deleted comment.

Authorizations:
OAuthApiKeyAuth
path Parameters
id
required
integer

Responses

Response samples

Content type
application/json
{
  • "comment": {
    }
}

Notifications

Get notifications

Return a list of recent activity on the users account with the most recent items first. content will be suitable for display in HTML and uses only the <strong>, <strike>, <small>, <br> and <font color="#FFEE44"> tags.

The type value indicates what the notification is about. Notification types may be added in the future without warning. Below is an incomplete list of notification types.

Type Meaning
0 Expense added
1 Expense updated
2 Expense deleted
3 Comment added
4 Added to group
5 Removed from group
6 Group deleted
7 Group settings changed
8 Added as friend
9 Removed as friend
10 News (a URL should be included)
11 Debt simplification
12 Group undeleted
13 Expense undeleted
14 Group currency conversion
15 Friend currency conversion

Note: While all parameters are optional, the server sets arbitrary (but large) limits on the number of notifications returned if you set a very old updated_after value or limit of 0 for a user with many notifications.

Authorizations:
OAuthApiKeyAuth
query Parameters
updated_after
string <date-time>
Example: updated_after=2020-07-28T20:46:00Z

If provided, returns only notifications after this time.

limit
integer
Default: 0

Omit (or provide 0) to get the maximum number of notifications.

Responses

Response samples

Content type
application/json
{
  • "notifications": [
    ]
}

Other

Supported currencies

Returns a list of all currencies allowed by the system. These are mostly ISO 4217 codes, but we do sometimes use pending codes or unofficial, colloquial codes (like BTC instead of XBT for Bitcoin).

Responses

Response samples

Content type
application/json
{
  • "currencies": [
    ]
}

Supported categories

Returns a list of all categories Splitwise allows for expenses. There are parent categories that represent groups of categories with subcategories for more specific categorization. When creating expenses, you must use a subcategory, not a parent category. If you intend for an expense to be represented by the parent category and nothing more specific, please use the "Other" subcategory.

Responses

Response samples

Content type
application/json
{}