---
title: "Get user balance summary"
method: GET
path: "/users/balances/summary"
tags: ["balances"]
---

# Get user balance summary

`GET /users/balances/summary`

## Request

- Base URL: `http://localhost:3001`
- URL: `http://localhost:3001/users/balances/summary`
- Auth: HTTP bearer

Get balance summary for the current user

## Response `200`

User balance summary retrieved successfully

- object
  - `data` UserBalanceSummaryResponseDto
    - `balances` UserBalanceResponseDto[], required
      - `id` string, required
      - `email` string, required
      - `displayName` string, required
      - `avatarUrl` string
      - `balance` number, required: Positive = owed money, negative = owes money
      - `currency` string, required
    - `groupBalances` GroupUserBalanceResponseDto[], required
      - `groupId` string, required
      - `groupName` string, required
      - `balance` number, required: Net balance in this group (positive = owed, negative = owes)
      - `currency` string, required
      - `absoluteBalance` number, required: Absolute value used for sorting
      - `groupIcon` string, required: Group icon identifier
    - `balancesByCurrency` object, required: Balances grouped by currency
    - `transactionCountByCurrency` object, required: Count of the user's transactions per currency (used to order currencies by activity)
    - `currenciesUsed` string[], required
  - `success` boolean
  - `message` string

## Other responses

- `400`: Bad Request - Invalid input or validation failed
- `401`: Unauthorized - Authentication required or invalid token
- `403`: Forbidden - Insufficient permissions to access this resource
- `404`: Not Found - The requested resource does not exist
- `500`: Internal Server Error - An unexpected error occurred

---

[API](https://skmtc.dev/spliteo/apis/spliteo-api.md) · [All operations](https://skmtc.dev/spliteo/apis/spliteo-api/llms.txt) · [OpenAPI document](https://skmtc.dev/spliteo/apis/spliteo-api/revisions/bd9b84f4e407?raw)