---
title: "Get list of beneficiaries"
method: GET
path: "/v1/beneficiaries"
---

# Get list of beneficiaries

`GET /v1/beneficiaries`

Get list of beneficiaries

## Query parameters

- `query` string
- `per_page` integer

## Headers

- `X-BUSINESS-API-KEY` string, required

## Response `200`

200

- object
  - `data` object[], required
    - `id` string, required
    - `status` string, required
    - `country` string, required
    - `currency` string, required
    - `transfer_method` string, required
    - `transfer_type` string, required
    - `nickname` string, required
    - `remark` string, nullable, required
    - `holder_name` string, required
    - `holder_type` string, required
    - `bank_branch_code` string, required
    - `account_number` string, required
    - `bank_name` string, required
    - `bank_id` string, required
    - `email` string, required
    - `bank_swift_code` string, required
    - `is_favourite` boolean, required
    - `created_by` object, required
      - `id` string, required
      - `display_name` string, required
      - `first_name` string, required
      - `last_name` string, required
    - `created_at` string, required
    - `updated_at` string, required
    - `deleted_at` string, nullable, required
  - `links` object, required
    - `first` string, required
    - `last` string, required
    - `prev` unknown, required
    - `next` string, required
  - `meta` object, required
    - `current_page` number, required
    - `from` number, required
    - `last_page` number, required
    - `links` object[], required
      - `url` string
      - `label` string, required
      - `active` boolean, required
    - `path` string, required
    - `per_page` number, required
    - `to` number, required
    - `total` number, required

---

[API](https://skmtc.net/hitpayapp/apis/hitpay-api.md) · [All operations](https://skmtc.net/hitpayapp/apis/hitpay-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hitpayapp/hitpay-api/revisions/6aae1a736990/schema)