---
title: "Retrieve Settlements"
method: GET
path: "/settlements"
tags: ["Settlements"]
---

# Retrieve Settlements

`GET /settlements`

Retrieves a list of Settlements.

## Query parameters

- `from` string, required
- `to` string, required
- `status` 'PENDING' | 'APPROVED' | 'SUCCESSFUL' — The current status of the settlement.
- `settlementProfileID` string — A settlement profile identifier that links to a specific bank account for fund settlement.
- `limit` integer
- `offset` string
- `direction` 'prev' | 'next'

## Response `200`

Retrieving a list of Settlements was Successful.

- SingleSettlementReports
  - `pageSize` integer — The amount of results on the page.
  - `limit` integer — The maximum number of results per page.
  - `settlements` SingleSettlementDetails[]
    - `id` string — A unique identifier that identifies the settlement.
    - `settlementDate` string
    - `partnerID` string — The unique identifier of the firm.
    - `status` 'PENDING' | 'APPROVED' | 'SUCCESSFUL' — The current status of the settlement.
    - `totalAmount` number — The total aggregated sum of all underlying accounts and transactions.
    - `createdAt` string
    - `updatedAt` string
    - `settlementProfileID` string — A settlement profile identifier that links to a specific bank account for fund settlement.
    - `attestedAt` string — The date and time when the settlement report was attested.

---

[API](https://skmtc.net/drivewealth/apis/authentication-apis.md) · [All operations](https://skmtc.net/drivewealth/apis/authentication-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/drivewealth/authentication-apis/versions/9fced6d0ac41/schema)