---
title: "List all purposes"
method: GET
path: "/open-api/v3/purposes"
tags: ["Payouts"]
---

# List all purposes

`GET /open-api/v3/purposes`

## Request

- Base URL: `https://api-sandbox.interlace.money`
- URL: `https://api-sandbox.interlace.money/open-api/v3/purposes`
- Auth: API key in header `x-access-token`

Retrieves a list of purposes.

## Query parameters

- `accountId` string, required: The UUID of the account.
- `payeeId` string, required: Beneficiary ID
- `balanceId` string, required: A source of funds.

## Response `200`

OK

- PaymentPurposesResVO
  - `code` string: Error code
  - `message` string: Error message
  - `data` PaymentPurpose[], required: purpose list
    - `id` string, required: id
    - `purposeDescriptionZh` string: Purpose description in Chinese
    - `purposeDescriptionEn` string, required: Purpose description in English

## Other responses

- `400`: Bad Request

---

[API](https://skmtc.dev/interlace/apis/business-transfer.md) - [All operations](https://skmtc.dev/interlace/apis/business-transfer/llms.txt) - [OpenAPI document](https://skmtc.dev/interlace/apis/business-transfer/revisions/9bf171b6fb7f?raw)