---
title: "Get group settlement"
method: GET
path: "/groups/{groupId}/settlement"
tags: ["settlements"]
---

# Get group settlement

`GET /groups/{groupId}/settlement`

## Request

- Base URL: `http://localhost:3001`
- URL: `http://localhost:3001/groups/{groupId}/settlement`
- Auth: HTTP bearer

Get optimal settlement transactions for a group

## Path parameters

- `groupId` string, required

## Response `200`

Group settlement retrieved successfully

- object
  - `data` GroupSettlementResponseDto
    - `groupId` string, required: Group ID
    - `transactionsByCurrency` object, required: Settlement transactions organized by currency
    - `totalTransactions` number, required: Total number of settlement transactions across all currencies
    - `currenciesUsed` string[], required: All currencies used in settlements
    - `defaultCurrency` string: Default currency for display
  - `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)