---
title: "List Beneficiaries"
method: GET
path: "/beneficiaries"
---

# List Beneficiaries

`GET /beneficiaries`

## Request

- Base URL: `https://sandbox.openpayd.com/api`
- URL: `https://sandbox.openpayd.com/api/beneficiaries`
- Auth: API key in header `Authorization`

Get a list of all parent beneficiaries filtered by various params.

## Query parameters

- `beneficiaryType` string
- `companyName` string
- `title` string
- `firstName` string
- `lastName` string
- `tag` string
- `query` string
- `page` integer
- `size` integer
- `sort` string

## Response `200`

200

- object
  - `content` object[]
    - `beneficiaryType` string
    - `id` string
    - `accountHolderId` string
    - `title` string
    - `firstName` string
    - `lastName` string
    - `friendlyName` string
    - `uploadedKycDocument` boolean
  - `pageable` object
    - `sort` object
      - `sorted` boolean
      - `unsorted` boolean
      - `empty` boolean
    - `pageSize` integer
    - `pageNumber` integer
    - `offset` integer
    - `paged` boolean
    - `unpaged` boolean
  - `totalPages` integer
  - `totalElements` integer
  - `last` boolean
  - `first` boolean
  - `sort` object
    - `sorted` boolean
    - `unsorted` boolean
    - `empty` boolean
  - `numberOfElements` integer
  - `size` integer
  - `number` integer
  - `empty` boolean

## Other responses

- `400`: 400

---

[API](https://skmtc.dev/openpayd/apis/openpayd-api.md) - [All operations](https://skmtc.dev/openpayd/apis/openpayd-api/llms.txt) - [OpenAPI document](https://skmtc.dev/openpayd/apis/openpayd-api/revisions/0f820ef79fab?raw)