---
title: "Get settlement opportunities"
method: GET
path: "/settlements/cross-group/opportunities/{userId}"
tags: ["cross group settlements"]
---

# Get settlement opportunities

`GET /settlements/cross-group/opportunities/{userId}`

## Request

- Base URL: `http://localhost:3001`
- URL: `http://localhost:3001/settlements/cross-group/opportunities/{userId}`
- Auth: HTTP bearer

Get cross-group settlement opportunities for a user

## Path parameters

- `userId` string, required

## Response `200`

Settlement opportunities retrieved successfully

- object
  - `data` CrossGroupSettlementOpportunityResponseDto[]
    - `otherUserId` string, required: ID of the other user
    - `otherUserDisplayName` string, required: Display name of the other user
    - `netAmount` number, required: Net settlement amount across selected groups
    - `currency` string, required: Currency code
    - `groupIds` string[], required: List of group IDs that contribute to this settlement
  - `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)